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, "windowsPathsNoEscape">,
  ) => string

• 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

• 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, "windowsPathsNoEscape">,
  ) => string