minimatch
    Preparing search index...

    Function minimatch

    Index

    Properties

    AST braceExpand defaults escape filter GLOBSTAR makeRe match Minimatch sep unescape

    Properties

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

    Type declaration

      • (
            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

        Returns string

    filter: (pattern: string, options?: MinimatchOptions) => (p: string) => boolean
    GLOBSTAR: typeof GLOBSTAR
    makeRe: (pattern: string, options?: MinimatchOptions) => false | MMRegExp
    match: (list: string[], pattern: string, options?: MinimatchOptions) => string[]
    Minimatch: typeof Minimatch
    sep: Sep
    unescape: (
        s: string,
        __namedParameters?: Pick<MinimatchOptions, "windowsPathsNoEscape">,
    ) => string

    Type declaration

      • (
            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

        Returns string

    Settings

    Member Visibility

    On This Page

    Properties