Interface SrcOptions

Hierarchy

Properties

absolute? allowEmpty? base? buffer? cache? cwd? cwdbase? debug? dirMode? dot? flipNegate? follow? followSymlinks? fs? ignore? mark? matchBase? nobrace? nocase? nocomment? nodir? noext? noglobstar? nomount? nonegate? nonull? nosort? nounique? partial? passthrough? read? realpath? realpathCache? relative? removeBOM? resolveSymlinks? root? silent? since? sourcemaps? stat? statCache? strict? stripBOM? symlinks? sync? uniqueBy? windowsPathsNoEscape?

Properties

Optional absolute

absolute?: boolean

Optional allowEmpty

allowEmpty?: boolean

Prevents stream from emitting an error when file not found.

Optional base

base?: string

Specifies the folder relative to the cwd This is used to determine the file names when saving in .dest() Default: where the glob begins

Optional buffer

buffer?: boolean

Setting this to false will make file.contents a paused stream If true it will buffer the file contents Default: true

Optional cache

cache?: {
    [path: string]: boolean | "DIR" | "FILE" | ReadonlyArray<string>;
}

Type declaration

  • [path: string]: boolean | "DIR" | "FILE" | ReadonlyArray<string>

Optional cwd

cwd?: string

Specifies the working directory the folder is relative to

Optional cwdbase

cwdbase?: boolean

Whether or not the cwd and base should be the same.

Optional debug

debug?: boolean

Dump a ton of stuff to stderr.

Default

false

Optional dirMode

dirMode?: number

The mode the directory should be created with. Default: the process mode

Optional dot

dot?: boolean

Whether or not you want globs to match on dot files or not (e.g., .gitignore).

Optional flipNegate

flipNegate?: boolean

Returns from negate expressions the same as if they were not negated. (Ie, true on a hit, false on a miss.)

Default

false

Optional follow

follow?: boolean

Optional followSymlinks

followSymlinks?: boolean

Whether or not to recursively resolve symlinks to their targets. Setting to false to preserve them as symlinks and make file.symlink equal the original symlink's target path. Default: true

Optional fs

fs?: "fs"

Optional ignore

ignore?: string | readonly string[]

Optional mark

mark?: boolean

Optional matchBase

matchBase?: any

If set, then patterns without slashes will be matched against the basename of the path if it contains slashes. For example, a?b would match the path /xyz/123/acb, but not /xyz/acb/123.

Default

false

Optional nobrace

nobrace?: boolean

Do not expand {a,b} and {1..3} brace sets.

Default

false

Optional nocase

nocase?: boolean

Perform a case-insensitive match.

Default

false

Optional nocomment

nocomment?: boolean

Suppress the behavior of treating # at the start of a pattern as a comment.

Default

false

Optional nodir

nodir?: boolean

Optional noext

noext?: boolean

Disable "extglob" style patterns like +(a|b).

Default

false

Optional noglobstar

noglobstar?: boolean

Disable ** matching against multiple folder names.

Default

false

Optional nomount

nomount?: boolean

Optional nonegate

nonegate?: boolean

Suppress the behavior of treating a leading ! character as negation.

Default

false

Optional nonull

nonull?: boolean

When a match is not found by minimatch.match, return a list containing the pattern itself if this option is set. Otherwise, an empty list is returned if there are no matches.

Default

false

Optional nosort

nosort?: boolean

Optional nounique

nounique?: boolean

Optional partial

partial?: boolean

Compare a partial path to a pattern. As long as the parts of the path that are present are not contradicted by the pattern, it will be treated as a match. This is useful in applications where you're walking through a folder structure, and don't yet have the full path, but want to ensure that you do not walk down paths that can never be a match.

Default

false

Example

import minimatch = require("minimatch");

minimatch('/a/b', '/a/*' + '/c/d', { partial: true })  // true, might be /a/b/c/d
minimatch('/a/b', '/**' + '/d', { partial: true })     // true, might be /a/b/.../d
minimatch('/x/y/z', '/a/**' + '/z', { partial: true }) // false, because x !== a

Optional passthrough

passthrough?: boolean

Setting this to true will create a duplex stream, one that passes through items and emits globbed files. Default: false

Optional read

read?: boolean

Setting this to false will ignore the contents of the file and disable writing to disk to speed up operations Default: true

Optional realpath

realpath?: boolean

Optional realpathCache

realpathCache?: {
    [path: string]: string;
}

Type declaration

  • [path: string]: string

Optional relative

relative?: boolean

Whether or not the symlink should be relative or absolute. Default: false

Optional removeBOM

removeBOM?: boolean

Causes the BOM to be removed on UTF-8 encoded files. Set to false if you need the BOM for some reason. Default: true

Optional resolveSymlinks

resolveSymlinks?: boolean

Whether or not to recursively resolve symlinks to their targets. Setting to false to preserve them as symlinks and make file.symlink equal the original symlink's target path. Default: false

Optional root

root?: string

Optional silent

silent?: boolean

Optional since

since?: number | Date

Only find files that have been modified since the time specified

Optional sourcemaps

sourcemaps?: boolean

Setting this to true will enable sourcemaps. Default: false

Optional stat

stat?: boolean

Optional statCache

statCache?: {
    [path: string]: false | {
        isDirectory(): boolean;
    } | undefined;
}

Type declaration

  • [path: string]: false | {
        isDirectory(): boolean;
    } | undefined

Optional strict

strict?: boolean

Optional stripBOM

stripBOM?: boolean

Causes the BOM to be stripped on UTF-8 encoded files. Set to false if you need the BOM for some reason.

Optional symlinks

symlinks?: {
    [path: string]: boolean | undefined;
}

Type declaration

  • [path: string]: boolean | undefined

Optional sync

sync?: boolean

Optional uniqueBy

uniqueBy?: UniqueByStringPredicate | UniqueByFunctionPredicate

Filters stream to remove duplicates based on the string property name or the result of function. When using a function, the function receives the streamed data (objects containing cwd, base, path properties) to compare against.

Optional windowsPathsNoEscape

windowsPathsNoEscape?: boolean

Use \\ as a path separator only, and never as an escape character. If set, all \\ characters are replaced with / in the pattern. Note that this makes it impossible to match against paths containing literal glob pattern characters, but allows matching with patterns constructed using path.join() and path.resolve() on Windows platforms, mimicking the (buggy!) behavior of earlier versions on Windows. Please use with caution, and be mindful of the caveat about Windows paths

For legacy reasons, this is also set if options.allowWindowsEscape is set to the exact value false.

Default

false

Settings

Member Visibility

Theme