Variable defaults

Type declaration

• • (def: MinimatchOptions): {
        AST: typeof AST;
        GLOBSTAR: typeof GLOBSTAR;
        Minimatch: typeof Minimatch;
        braceExpand: ((pattern: string, options?: MinimatchOptions) => string[]);
        defaults: (def: MinimatchOptions) => { (p: string, pattern: string, options?: MinimatchOptions): boolean; sep: Sep; GLOBSTAR: unique symbol; filter: (pattern: string, options?: MinimatchOptions) => (p: string) => boolean; ... 7 more ...; unescape: (s: string, { windowsPathsNoEscape, }?: Pick<...>) => string; };
        escape: ((s: string, __namedParameters?: Pick<MinimatchOptions, "windowsPathsNoEscape">) => string);
        filter: ((pattern: string, options?: MinimatchOptions) => ((p: string) => boolean));
        makeRe: ((pattern: string, options?: MinimatchOptions) => false | MMRegExp);
        match: ((list: string[], pattern: string, options?: MinimatchOptions) => string[]);
        sep: Sep;
        unescape: ((s: string, __namedParameters?: Pick<MinimatchOptions, "windowsPathsNoEscape">) => string);
        (p: string, pattern: string, options?: MinimatchOptions): boolean;
    }

  • Parameters

    • def: MinimatchOptions

    Returns {
        AST: typeof AST;
        GLOBSTAR: typeof GLOBSTAR;
        Minimatch: typeof Minimatch;
        braceExpand: ((pattern: string, options?: MinimatchOptions) => string[]);
        defaults: (def: MinimatchOptions) => { (p: string, pattern: string, options?: MinimatchOptions): boolean; sep: Sep; GLOBSTAR: unique symbol; filter: (pattern: string, options?: MinimatchOptions) => (p: string) => boolean; ... 7 more ...; unescape: (s: string, { windowsPathsNoEscape, }?: Pick<...>) => string; };
        escape: ((s: string, __namedParameters?: Pick<MinimatchOptions, "windowsPathsNoEscape">) => string);
        filter: ((pattern: string, options?: MinimatchOptions) => ((p: string) => boolean));
        makeRe: ((pattern: string, options?: MinimatchOptions) => false | MMRegExp);
        match: ((list: string[], pattern: string, options?: MinimatchOptions) => string[]);
        sep: Sep;
        unescape: ((s: string, __namedParameters?: Pick<MinimatchOptions, "windowsPathsNoEscape">) => string);
        (p: string, pattern: string, options?: MinimatchOptions): boolean;
    }

    • • (p: string, pattern: string, options?: MinimatchOptions): boolean

      • Parameters

        • p: string

        • pattern: string

        • options: MinimatchOptions = {}

        Returns boolean

    • AST: typeof AST

    • GLOBSTAR: typeof GLOBSTAR

    • Minimatch: typeof Minimatch

    • braceExpand: ((pattern: string, options?: MinimatchOptions) => string[])

      • • (pattern: string, options?: MinimatchOptions): string[]

        • Parameters

          • pattern: string

          • options: MinimatchOptions = {}

          Returns string[]

    • defaults: (def: MinimatchOptions) => { (p: string, pattern: string, options?: MinimatchOptions): boolean; sep: Sep; GLOBSTAR: unique symbol; filter: (pattern: string, options?: MinimatchOptions) => (p: string) => boolean; ... 7 more ...; unescape: (s: string, { windowsPathsNoEscape, }?: Pick<...>) => string; }

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

      • • (s: string, __namedParameters?: Pick<MinimatchOptions, "windowsPathsNoEscape">): string

        • Escape all magic characters in a glob pattern.

          If the windowsPathsNoEscape | GlobOptions.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.

          Parameters

          • s: string

          • __namedParameters: Pick<MinimatchOptions, "windowsPathsNoEscape"> = {}

          Returns string

    • filter: ((pattern: string, options?: MinimatchOptions) => ((p: string) => boolean))

      • • (pattern: string, options?: MinimatchOptions): ((p: string) => boolean)

        • Parameters

          • pattern: string

          • options: MinimatchOptions = {}

          Returns ((p: string) => boolean)

          • • (p: string): boolean

            • Parameters

              • p: string

              Returns boolean

    • makeRe: ((pattern: string, options?: MinimatchOptions) => false | MMRegExp)

      • • (pattern: string, options?: MinimatchOptions): false | MMRegExp

        • Parameters

          • pattern: string

          • options: MinimatchOptions = {}

          Returns false | MMRegExp

    • match: ((list: string[], pattern: string, options?: MinimatchOptions) => string[])

      • • (list: string[], pattern: string, options?: MinimatchOptions): string[]

        • Parameters

          • list: string[]

          • pattern: string

          • options: MinimatchOptions = {}

          Returns string[]

    • sep: Sep

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

      • • (s: string, __namedParameters?: Pick<MinimatchOptions, "windowsPathsNoEscape">): string

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

          If the windowsPathsNoEscape option is used, then square-brace escapes are removed, but not backslash escapes. For example, it will turn the string '[*]' into *, but it will not turn '\\*' into '*', becuase \ is a path separator in windowsPathsNoEscape mode.

          When windowsPathsNoEscape is not set, then both brace escapes and backslash escapes are removed.

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

          Parameters

          • s: string

          • __namedParameters: Pick<MinimatchOptions, "windowsPathsNoEscape"> = {}

          Returns string