Variable globConst

Type Declaration

• • (
        pattern: string | string[],
        options?: GlobOptionsWithFileTypesUnset,
    ): Promise<string[]>

  • Perform an asynchronous glob search for the pattern(s) specified. Returns Path objects if the withFileTypes option is set to true. See GlobOptions for full option descriptions.

    Parameters

    • pattern: string | string[]
    • Optionaloptions: GlobOptionsWithFileTypesUnset

    Returns Promise<string[]>

  • (
        pattern: string | string[],
        options: GlobOptionsWithFileTypesTrue,
    ): Promise<Path[]>

  • Perform an asynchronous glob search for the pattern(s) specified. Returns Path objects if the withFileTypes option is set to true. See GlobOptions for full option descriptions.

    Parameters

    • pattern: string | string[]
    • options: GlobOptionsWithFileTypesTrue

    Returns Promise<Path[]>

  • (
        pattern: string | string[],
        options: GlobOptionsWithFileTypesFalse,
    ): Promise<string[]>

  • Perform an asynchronous glob search for the pattern(s) specified. Returns Path objects if the withFileTypes option is set to true. See GlobOptions for full option descriptions.

    Parameters

    • pattern: string | string[]
    • options: GlobOptionsWithFileTypesFalse

    Returns Promise<string[]>

  • (pattern: string | string[], options: GlobOptions): Promise<string[] | Path[]>

  • Perform an asynchronous glob search for the pattern(s) specified. Returns Path objects if the withFileTypes option is set to true. See GlobOptions for full option descriptions.

    Parameters

    • pattern: string | string[]
    • options: GlobOptions

    Returns Promise<string[] | Path[]>

• escape: (
      s: string,
      __namedParameters?: Pick<
          MinimatchOptions,
          "magicalBraces"
          | "windowsPathsNoEscape",
      >,
  ) => string

  Escape all magic characters in a glob pattern.

  If the MinimatchOptions.windowsPathsNoEscape option is used, then characters are escaped by wrapping in [], because a magic character wrapped in a character class can only be satisfied by that exact character. In this mode, `` is not escaped, because it is not interpreted as a magic character, but instead as a path separator.

  If the MinimatchOptions.magicalBraces option is used, then braces ({ and }) will be escaped.

• glob: {
      (
          pattern: string | string[],
          options?: GlobOptionsWithFileTypesUnset,
      ): Promise<string[]>;
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesTrue,
      ): Promise<Path[]>;
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesFalse,
      ): Promise<string[]>;
      (
          pattern: string | string[],
          options: GlobOptions,
      ): Promise<string[] | Path[]>;
  }

• Glob: typeof Glob

• globIterate: {
      (
          pattern: string | string[],
          options?: GlobOptionsWithFileTypesUnset,
      ): AsyncGenerator<string, void, void>;
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesTrue,
      ): AsyncGenerator<Path, void, void>;
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesFalse,
      ): AsyncGenerator<string, void, void>;
      (
          pattern: string | string[],
          options: GlobOptions,
      ): AsyncGenerator<string, void, void> | AsyncGenerator<Path, void, void>;
  }

• globIterateSync: {
      (
          pattern: string | string[],
          options?: GlobOptionsWithFileTypesUnset,
      ): Generator<string, void, void>;
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesTrue,
      ): Generator<Path, void, void>;
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesFalse,
      ): Generator<string, void, void>;
      (
          pattern: string | string[],
          options: GlobOptions,
      ): Generator<string, void, void> | Generator<Path, void, void>;
  }

• globStream: {
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesFalse,
      ): Minipass<string, string>;
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesTrue,
      ): Minipass<Path, Path>;
      (
          pattern: string | string[],
          options?: GlobOptionsWithFileTypesUnset,
      ): Minipass<string, string>;
      (
          pattern: string | string[],
          options: GlobOptions,
      ):
          | Minipass<Path, Path, Events<Path>>
          | Minipass<string, string, Events<string>>;
  }

• globStreamSync: {
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesTrue,
      ): Minipass<Path, Path>;
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesFalse,
      ): Minipass<string, string>;
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesUnset,
      ): Minipass<string, string>;
      (
          pattern: string | string[],
          options: GlobOptions,
      ):
          | Minipass<Path, Path, Events<Path>>
          | Minipass<string, string, Events<string>>;
  }

• globSync: {
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesFalse,
      ): string[];
      (pattern: string | string[], options: GlobOptionsWithFileTypesTrue): Path[];
      (
          pattern: string | string[],
          options?: GlobOptionsWithFileTypesUnset,
      ): string[];
      (pattern: string | string[], options: GlobOptions): string[] | Path[];
  }

• hasMagic: (pattern: string | string[], options?: GlobOptions) => boolean

  Return true if the patterns provided contain any magic glob characters, given the options provided.

  Brace expansion is not considered "magic" unless the magicalBraces option is set, as brace expansion just turns one string into an array of strings. So a pattern like 'x{a,b}y' would return false, because 'xay' and 'xby' both do not contain any magic glob characters, and it's treated the same as if you had called it on ['xay', 'xby']. When magicalBraces:true is in the options, brace expansion is treated as a pattern having magic.

• iterate: {
      (
          pattern: string | string[],
          options?: GlobOptionsWithFileTypesUnset,
      ): AsyncGenerator<string, void, void>;
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesTrue,
      ): AsyncGenerator<Path, void, void>;
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesFalse,
      ): AsyncGenerator<string, void, void>;
      (
          pattern: string | string[],
          options: GlobOptions,
      ): AsyncGenerator<string, void, void> | AsyncGenerator<Path, void, void>;
  } & {
      sync: {
          (
              pattern: string | string[],
              options?: GlobOptionsWithFileTypesUnset,
          ): Generator<string, void, void>;
          (
              pattern: string | string[],
              options: GlobOptionsWithFileTypesTrue,
          ): Generator<Path, void, void>;
          (
              pattern: string | string[],
              options: GlobOptionsWithFileTypesFalse,
          ): Generator<string, void, void>;
          (
              pattern: string | string[],
              options: GlobOptions,
          ): Generator<string, void, void> | Generator<Path, void, void>;
      };
  }

• iterateSync: {
      (
          pattern: string | string[],
          options?: GlobOptionsWithFileTypesUnset,
      ): Generator<string, void, void>;
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesTrue,
      ): Generator<Path, void, void>;
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesFalse,
      ): Generator<string, void, void>;
      (
          pattern: string | string[],
          options: GlobOptions,
      ): Generator<string, void, void> | Generator<Path, void, void>;
  }

• stream: {
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesFalse,
      ): Minipass<string, string>;
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesTrue,
      ): Minipass<Path, Path>;
      (
          pattern: string | string[],
          options?: GlobOptionsWithFileTypesUnset,
      ): Minipass<string, string>;
      (
          pattern: string | string[],
          options: GlobOptions,
      ):
          | Minipass<Path, Path, Events<Path>>
          | Minipass<string, string, Events<string>>;
  } & {
      sync: {
          (
              pattern: string | string[],
              options: GlobOptionsWithFileTypesTrue,
          ): Minipass<Path, Path>;
          (
              pattern: string | string[],
              options: GlobOptionsWithFileTypesFalse,
          ): Minipass<string, string>;
          (
              pattern: string | string[],
              options: GlobOptionsWithFileTypesUnset,
          ): Minipass<string, string>;
          (
              pattern: string | string[],
              options: GlobOptions,
          ):
              | Minipass<Path, Path, Events<Path>>
              | Minipass<string, string, Events<string>>;
      };
  }

• streamSync: {
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesTrue,
      ): Minipass<Path, Path>;
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesFalse,
      ): Minipass<string, string>;
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesUnset,
      ): Minipass<string, string>;
      (
          pattern: string | string[],
          options: GlobOptions,
      ):
          | Minipass<Path, Path, Events<Path>>
          | Minipass<string, string, Events<string>>;
  }

• sync: {
      (
          pattern: string | string[],
          options: GlobOptionsWithFileTypesFalse,
      ): string[];
      (pattern: string | string[], options: GlobOptionsWithFileTypesTrue): Path[];
      (
          pattern: string | string[],
          options?: GlobOptionsWithFileTypesUnset,
      ): string[];
      (pattern: string | string[], options: GlobOptions): string[] | Path[];
  } & {
      iterate: {
          (
              pattern: string | string[],
              options?: GlobOptionsWithFileTypesUnset,
          ): Generator<string, void, void>;
          (
              pattern: string | string[],
              options: GlobOptionsWithFileTypesTrue,
          ): Generator<Path, void, void>;
          (
              pattern: string | string[],
              options: GlobOptionsWithFileTypesFalse,
          ): Generator<string, void, void>;
          (
              pattern: string | string[],
              options: GlobOptions,
          ): Generator<string, void, void> | Generator<Path, void, void>;
      };
      stream: {
          (
              pattern: string | string[],
              options: GlobOptionsWithFileTypesTrue,
          ): Minipass<Path, Path>;
          (
              pattern: string | string[],
              options: GlobOptionsWithFileTypesFalse,
          ): Minipass<string, string>;
          (
              pattern: string | string[],
              options: GlobOptionsWithFileTypesUnset,
          ): Minipass<string, string>;
          (
              pattern: string | string[],
              options: GlobOptions,
          ):
              | Minipass<Path, Path, Events<Path>>
              | Minipass<string, string, Events<string>>;
      };
  }

• unescape: (
      s: string,
      __namedParameters?: Pick<
          MinimatchOptions,
          "magicalBraces"
          | "windowsPathsNoEscape",
      >,
  ) => string

  Un-escape a string that has been escaped with escape.

  If the MinimatchOptions.windowsPathsNoEscape option is used, then square-bracket escapes are removed, but not backslash escapes.

  For example, it will turn the string '[*]' into *, but it will not turn '\\*' into '*', because \ is a path separator in windowsPathsNoEscape mode.

  When windowsPathsNoEscape is not set, then both square-bracket escapes and backslash escapes are removed.

  Slashes (and backslashes in windowsPathsNoEscape mode) cannot be escaped or unescaped.

  When magicalBraces is not set, escapes of braces ({ and }) will not be unescaped.