Function glob

glob(
    source: string | readonly string[],
    options: {
        absolute?: boolean;
        baseNameMatch?: boolean;
        braceExpansion?: boolean;
        caseSensitiveMatch?: boolean;
        concurrency?: number;
        cwd?: string;
        deep?: number;
        dot?: boolean;
        extglob?: boolean;
        followSymbolicLinks?: boolean;
        fs?: {
            lstat?: StatAsynchronousMethod;
            lstatSync?: StatSynchronousMethod;
            readdir?: ReaddirAsynchronousMethod;
            readdirSync?: ReaddirSynchronousMethod;
            stat?: StatAsynchronousMethod;
            statSync?: StatSynchronousMethod;
        };
        globstar?: boolean;
        ignore?: readonly string[];
        markDirectories?: boolean;
        objectMode?: boolean;
        onlyDirectories?: boolean;
        onlyFiles?: boolean;
        stats?: boolean;
        suppressErrors?: boolean;
        throwErrorOnBrokenSymbolicLink?: boolean;
        unique?: boolean;
    } & EntryObjectPredicate,
): Promise<
    Result<
        readonly {
            dirent: {
                name: string;
                parentPath: string;
                isBlockDevice(): boolean;
                isCharacterDevice(): boolean;
                isDirectory(): boolean;
                isFIFO(): boolean;
                isFile(): boolean;
                isSocket(): boolean;
                isSymbolicLink(): boolean;
            };
            name: string;
            path: string;
            stats?: {
                atime: {
                    "[toPrimitive]"(hint: "default"): string;
                    "[toPrimitive]"(hint: "string"): string;
                    "[toPrimitive]"(hint: "number"): number;
                    "[toPrimitive]"(hint: string): string | number;
                    getDate(): number;
                    getDay(): number;
                    getFullYear(): number;
                    getHours(): number;
                    getMilliseconds(): number;
                    getMinutes(): number;
                    getMonth(): number;
                    getSeconds(): number;
                    getTime(): number;
                    getTimezoneOffset(): number;
                    getUTCDate(): number;
                    getUTCDay(): number;
                    getUTCFullYear(): number;
                    getUTCHours(): number;
                    getUTCMilliseconds(): number;
                    getUTCMinutes(): number;
                    getUTCMonth(): number;
                    getUTCSeconds(): number;
                    setDate(date: number): number;
                    setFullYear(year: number, month?: number, date?: number): number;
                    setHours(
                        hours: number,
                        min?: number,
                        sec?: number,
                        ms?: number,
                    ): number;
                    setMilliseconds(ms: number): number;
                    setMinutes(min: number, sec?: number, ms?: number): number;
                    setMonth(month: number, date?: number): number;
                    setSeconds(sec: number, ms?: number): number;
                    setTime(time: number): number;
                    setUTCDate(date: number): number;
                    setUTCFullYear(year: number, month?: number, date?: number): number;
                    setUTCHours(
                        hours: number,
                        min?: number,
                        sec?: number,
                        ms?: number,
                    ): number;
                    setUTCMilliseconds(ms: number): number;
                    setUTCMinutes(min: number, sec?: number, ms?: number): number;
                    setUTCMonth(month: number, date?: number): number;
                    setUTCSeconds(sec: number, ms?: number): number;
                    toDateString(): string;
                    toISOString(): string;
                    toJSON(key?: any): string;
                    toLocaleDateString(): string;
                    toLocaleDateString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleDateString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleString(): string;
                    toLocaleString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleTimeString(): string;
                    toLocaleTimeString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleTimeString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toString(): string;
                    toTimeString(): string;
                    toUTCString(): string;
                    valueOf(): number;
                };
                atimeMs: number;
                birthtime: {
                    "[toPrimitive]"(hint: "default"): string;
                    "[toPrimitive]"(hint: "string"): string;
                    "[toPrimitive]"(hint: "number"): number;
                    "[toPrimitive]"(hint: string): string | number;
                    getDate(): number;
                    getDay(): number;
                    getFullYear(): number;
                    getHours(): number;
                    getMilliseconds(): number;
                    getMinutes(): number;
                    getMonth(): number;
                    getSeconds(): number;
                    getTime(): number;
                    getTimezoneOffset(): number;
                    getUTCDate(): number;
                    getUTCDay(): number;
                    getUTCFullYear(): number;
                    getUTCHours(): number;
                    getUTCMilliseconds(): number;
                    getUTCMinutes(): number;
                    getUTCMonth(): number;
                    getUTCSeconds(): number;
                    setDate(date: number): number;
                    setFullYear(year: number, month?: number, date?: number): number;
                    setHours(
                        hours: number,
                        min?: number,
                        sec?: number,
                        ms?: number,
                    ): number;
                    setMilliseconds(ms: number): number;
                    setMinutes(min: number, sec?: number, ms?: number): number;
                    setMonth(month: number, date?: number): number;
                    setSeconds(sec: number, ms?: number): number;
                    setTime(time: number): number;
                    setUTCDate(date: number): number;
                    setUTCFullYear(year: number, month?: number, date?: number): number;
                    setUTCHours(
                        hours: number,
                        min?: number,
                        sec?: number,
                        ms?: number,
                    ): number;
                    setUTCMilliseconds(ms: number): number;
                    setUTCMinutes(min: number, sec?: number, ms?: number): number;
                    setUTCMonth(month: number, date?: number): number;
                    setUTCSeconds(sec: number, ms?: number): number;
                    toDateString(): string;
                    toISOString(): string;
                    toJSON(key?: any): string;
                    toLocaleDateString(): string;
                    toLocaleDateString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleDateString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleString(): string;
                    toLocaleString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleTimeString(): string;
                    toLocaleTimeString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleTimeString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toString(): string;
                    toTimeString(): string;
                    toUTCString(): string;
                    valueOf(): number;
                };
                birthtimeMs: number;
                blksize: number;
                blocks: number;
                ctime: {
                    "[toPrimitive]"(hint: "default"): string;
                    "[toPrimitive]"(hint: "string"): string;
                    "[toPrimitive]"(hint: "number"): number;
                    "[toPrimitive]"(hint: string): string | number;
                    getDate(): number;
                    getDay(): number;
                    getFullYear(): number;
                    getHours(): number;
                    getMilliseconds(): number;
                    getMinutes(): number;
                    getMonth(): number;
                    getSeconds(): number;
                    getTime(): number;
                    getTimezoneOffset(): number;
                    getUTCDate(): number;
                    getUTCDay(): number;
                    getUTCFullYear(): number;
                    getUTCHours(): number;
                    getUTCMilliseconds(): number;
                    getUTCMinutes(): number;
                    getUTCMonth(): number;
                    getUTCSeconds(): number;
                    setDate(date: number): number;
                    setFullYear(year: number, month?: number, date?: number): number;
                    setHours(
                        hours: number,
                        min?: number,
                        sec?: number,
                        ms?: number,
                    ): number;
                    setMilliseconds(ms: number): number;
                    setMinutes(min: number, sec?: number, ms?: number): number;
                    setMonth(month: number, date?: number): number;
                    setSeconds(sec: number, ms?: number): number;
                    setTime(time: number): number;
                    setUTCDate(date: number): number;
                    setUTCFullYear(year: number, month?: number, date?: number): number;
                    setUTCHours(
                        hours: number,
                        min?: number,
                        sec?: number,
                        ms?: number,
                    ): number;
                    setUTCMilliseconds(ms: number): number;
                    setUTCMinutes(min: number, sec?: number, ms?: number): number;
                    setUTCMonth(month: number, date?: number): number;
                    setUTCSeconds(sec: number, ms?: number): number;
                    toDateString(): string;
                    toISOString(): string;
                    toJSON(key?: any): string;
                    toLocaleDateString(): string;
                    toLocaleDateString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleDateString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleString(): string;
                    toLocaleString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleTimeString(): string;
                    toLocaleTimeString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleTimeString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toString(): string;
                    toTimeString(): string;
                    toUTCString(): string;
                    valueOf(): number;
                };
                ctimeMs: number;
                dev: number;
                gid: number;
                ino: number;
                mode: number;
                mtime: {
                    "[toPrimitive]"(hint: "default"): string;
                    "[toPrimitive]"(hint: "string"): string;
                    "[toPrimitive]"(hint: "number"): number;
                    "[toPrimitive]"(hint: string): string | number;
                    getDate(): number;
                    getDay(): number;
                    getFullYear(): number;
                    getHours(): number;
                    getMilliseconds(): number;
                    getMinutes(): number;
                    getMonth(): number;
                    getSeconds(): number;
                    getTime(): number;
                    getTimezoneOffset(): number;
                    getUTCDate(): number;
                    getUTCDay(): number;
                    getUTCFullYear(): number;
                    getUTCHours(): number;
                    getUTCMilliseconds(): number;
                    getUTCMinutes(): number;
                    getUTCMonth(): number;
                    getUTCSeconds(): number;
                    setDate(date: number): number;
                    setFullYear(year: number, month?: number, date?: number): number;
                    setHours(
                        hours: number,
                        min?: number,
                        sec?: number,
                        ms?: number,
                    ): number;
                    setMilliseconds(ms: number): number;
                    setMinutes(min: number, sec?: number, ms?: number): number;
                    setMonth(month: number, date?: number): number;
                    setSeconds(sec: number, ms?: number): number;
                    setTime(time: number): number;
                    setUTCDate(date: number): number;
                    setUTCFullYear(year: number, month?: number, date?: number): number;
                    setUTCHours(
                        hours: number,
                        min?: number,
                        sec?: number,
                        ms?: number,
                    ): number;
                    setUTCMilliseconds(ms: number): number;
                    setUTCMinutes(min: number, sec?: number, ms?: number): number;
                    setUTCMonth(month: number, date?: number): number;
                    setUTCSeconds(sec: number, ms?: number): number;
                    toDateString(): string;
                    toISOString(): string;
                    toJSON(key?: any): string;
                    toLocaleDateString(): string;
                    toLocaleDateString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleDateString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleString(): string;
                    toLocaleString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleTimeString(): string;
                    toLocaleTimeString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleTimeString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toString(): string;
                    toTimeString(): string;
                    toUTCString(): string;
                    valueOf(): number;
                };
                mtimeMs: number;
                nlink: number;
                rdev: number;
                size: number;
                uid: number;
                isBlockDevice(): boolean;
                isCharacterDevice(): boolean;
                isDirectory(): boolean;
                isFIFO(): boolean;
                isFile(): boolean;
                isSocket(): boolean;
                isSymbolicLink(): boolean;
            };
        }[],
        unknown,
    >,
>
Parameters
- source: string | readonly string[]
- options: {
      absolute?: boolean;
      baseNameMatch?: boolean;
      braceExpansion?: boolean;
      caseSensitiveMatch?: boolean;
      concurrency?: number;
      cwd?: string;
      deep?: number;
      dot?: boolean;
      extglob?: boolean;
      followSymbolicLinks?: boolean;
      fs?: {
          lstat?: StatAsynchronousMethod;
          lstatSync?: StatSynchronousMethod;
          readdir?: ReaddirAsynchronousMethod;
          readdirSync?: ReaddirSynchronousMethod;
          stat?: StatAsynchronousMethod;
          statSync?: StatSynchronousMethod;
      };
      globstar?: boolean;
      ignore?: readonly string[];
      markDirectories?: boolean;
      objectMode?: boolean;
      onlyDirectories?: boolean;
      onlyFiles?: boolean;
      stats?: boolean;
      suppressErrors?: boolean;
      throwErrorOnBrokenSymbolicLink?: boolean;
      unique?: boolean;
  } & EntryObjectPredicate
  - Optional Readonlyabsolute?: boolean
    Return the absolute path for entries.
    
    Default
    false
  - Optional ReadonlybaseNameMatch?: boolean
    If set to true, then patterns without slashes will be matched against the basename of the path if it contains slashes.
    
    Default
    false
  - Optional ReadonlybraceExpansion?: boolean
    Enables Bash-like brace expansion.
    
    Default
    true
  - Optional ReadonlycaseSensitiveMatch?: boolean
    Enables a case-sensitive mode for matching files.
    
    Default
    true
  - Optional Readonlyconcurrency?: number
    Specifies the maximum number of concurrent requests from a reader to read directories.
    
    Default
    os.cpus().length
  - Optional Readonlycwd?: string
    The current working directory in which to search.
    
    Default
    process.cwd()
  - Optional Readonlydeep?: number
    Specifies the maximum depth of a read directory relative to the start directory.
    
    Default
    Infinity
  - Optional Readonlydot?: boolean
    Allow patterns to match entries that begin with a period (.).
    
    Default
    false
  - Optional Readonlyextglob?: boolean
    Enables Bash-like extglob functionality.
    
    Default
    true
  - Optional ReadonlyfollowSymbolicLinks?: boolean
    Indicates whether to traverse descendants of symbolic link directories.
    
    Default
    true
  - Optional Readonlyfs?: {
        lstat?: StatAsynchronousMethod;
        lstatSync?: StatSynchronousMethod;
        readdir?: ReaddirAsynchronousMethod;
        readdirSync?: ReaddirSynchronousMethod;
        stat?: StatAsynchronousMethod;
        statSync?: StatSynchronousMethod;
    }
    Custom implementation of methods for working with the file system.
    
    Default
    fs.*
  - Optional Readonlyglobstar?: boolean
    Enables recursively repeats a pattern containing **. If false, ** behaves exactly like *.
    
    Default
    true
  - Optional Readonlyignore?: readonly string[]
    An array of glob patterns to exclude matches. This is an alternative way to use negative patterns.
    
    Default
    []
  - Optional ReadonlymarkDirectories?: boolean
    Mark the directory path with the final slash.
    
    Default
    false
  - Optional ReadonlyobjectMode?: boolean
    Returns objects (instead of strings) describing entries.
    
    Default
    false
  - Optional ReadonlyonlyDirectories?: boolean
    Return only directories.
    
    Default
    false
  - Optional ReadonlyonlyFiles?: boolean
    Return only files.
    
    Default
    true
  - Optional Readonlystats?: boolean
    Enables an object mode (objectMode) with an additional stats field.
    
    Default
    false
  - Optional ReadonlysuppressErrors?: boolean
    By default this package suppress only ENOENT errors. Set to true to suppress any error.
    
    Default
    false
  - Optional ReadonlythrowErrorOnBrokenSymbolicLink?: boolean
    Throw an error when symbolic link is broken if true or safely return lstat call if false.
    
    Default
    false
  - Optional Readonlyunique?: boolean
    Ensures that the returned entries are unique.
    
    Default
    true
Returns Promise<
    Result<
        readonly {
            dirent: {
                name: string;
                parentPath: string;
                isBlockDevice(): boolean;
                isCharacterDevice(): boolean;
                isDirectory(): boolean;
                isFIFO(): boolean;
                isFile(): boolean;
                isSocket(): boolean;
                isSymbolicLink(): boolean;
            };
            name: string;
            path: string;
            stats?: {
                atime: {
                    "[toPrimitive]"(hint: "default"): string;
                    "[toPrimitive]"(hint: "string"): string;
                    "[toPrimitive]"(hint: "number"): number;
                    "[toPrimitive]"(hint: string): string | number;
                    getDate(): number;
                    getDay(): number;
                    getFullYear(): number;
                    getHours(): number;
                    getMilliseconds(): number;
                    getMinutes(): number;
                    getMonth(): number;
                    getSeconds(): number;
                    getTime(): number;
                    getTimezoneOffset(): number;
                    getUTCDate(): number;
                    getUTCDay(): number;
                    getUTCFullYear(): number;
                    getUTCHours(): number;
                    getUTCMilliseconds(): number;
                    getUTCMinutes(): number;
                    getUTCMonth(): number;
                    getUTCSeconds(): number;
                    setDate(date: number): number;
                    setFullYear(year: number, month?: number, date?: number): number;
                    setHours(
                        hours: number,
                        min?: number,
                        sec?: number,
                        ms?: number,
                    ): number;
                    setMilliseconds(ms: number): number;
                    setMinutes(min: number, sec?: number, ms?: number): number;
                    setMonth(month: number, date?: number): number;
                    setSeconds(sec: number, ms?: number): number;
                    setTime(time: number): number;
                    setUTCDate(date: number): number;
                    setUTCFullYear(year: number, month?: number, date?: number): number;
                    setUTCHours(
                        hours: number,
                        min?: number,
                        sec?: number,
                        ms?: number,
                    ): number;
                    setUTCMilliseconds(ms: number): number;
                    setUTCMinutes(min: number, sec?: number, ms?: number): number;
                    setUTCMonth(month: number, date?: number): number;
                    setUTCSeconds(sec: number, ms?: number): number;
                    toDateString(): string;
                    toISOString(): string;
                    toJSON(key?: any): string;
                    toLocaleDateString(): string;
                    toLocaleDateString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleDateString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleString(): string;
                    toLocaleString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleTimeString(): string;
                    toLocaleTimeString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleTimeString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toString(): string;
                    toTimeString(): string;
                    toUTCString(): string;
                    valueOf(): number;
                };
                atimeMs: number;
                birthtime: {
                    "[toPrimitive]"(hint: "default"): string;
                    "[toPrimitive]"(hint: "string"): string;
                    "[toPrimitive]"(hint: "number"): number;
                    "[toPrimitive]"(hint: string): string | number;
                    getDate(): number;
                    getDay(): number;
                    getFullYear(): number;
                    getHours(): number;
                    getMilliseconds(): number;
                    getMinutes(): number;
                    getMonth(): number;
                    getSeconds(): number;
                    getTime(): number;
                    getTimezoneOffset(): number;
                    getUTCDate(): number;
                    getUTCDay(): number;
                    getUTCFullYear(): number;
                    getUTCHours(): number;
                    getUTCMilliseconds(): number;
                    getUTCMinutes(): number;
                    getUTCMonth(): number;
                    getUTCSeconds(): number;
                    setDate(date: number): number;
                    setFullYear(year: number, month?: number, date?: number): number;
                    setHours(
                        hours: number,
                        min?: number,
                        sec?: number,
                        ms?: number,
                    ): number;
                    setMilliseconds(ms: number): number;
                    setMinutes(min: number, sec?: number, ms?: number): number;
                    setMonth(month: number, date?: number): number;
                    setSeconds(sec: number, ms?: number): number;
                    setTime(time: number): number;
                    setUTCDate(date: number): number;
                    setUTCFullYear(year: number, month?: number, date?: number): number;
                    setUTCHours(
                        hours: number,
                        min?: number,
                        sec?: number,
                        ms?: number,
                    ): number;
                    setUTCMilliseconds(ms: number): number;
                    setUTCMinutes(min: number, sec?: number, ms?: number): number;
                    setUTCMonth(month: number, date?: number): number;
                    setUTCSeconds(sec: number, ms?: number): number;
                    toDateString(): string;
                    toISOString(): string;
                    toJSON(key?: any): string;
                    toLocaleDateString(): string;
                    toLocaleDateString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleDateString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleString(): string;
                    toLocaleString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleTimeString(): string;
                    toLocaleTimeString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleTimeString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toString(): string;
                    toTimeString(): string;
                    toUTCString(): string;
                    valueOf(): number;
                };
                birthtimeMs: number;
                blksize: number;
                blocks: number;
                ctime: {
                    "[toPrimitive]"(hint: "default"): string;
                    "[toPrimitive]"(hint: "string"): string;
                    "[toPrimitive]"(hint: "number"): number;
                    "[toPrimitive]"(hint: string): string | number;
                    getDate(): number;
                    getDay(): number;
                    getFullYear(): number;
                    getHours(): number;
                    getMilliseconds(): number;
                    getMinutes(): number;
                    getMonth(): number;
                    getSeconds(): number;
                    getTime(): number;
                    getTimezoneOffset(): number;
                    getUTCDate(): number;
                    getUTCDay(): number;
                    getUTCFullYear(): number;
                    getUTCHours(): number;
                    getUTCMilliseconds(): number;
                    getUTCMinutes(): number;
                    getUTCMonth(): number;
                    getUTCSeconds(): number;
                    setDate(date: number): number;
                    setFullYear(year: number, month?: number, date?: number): number;
                    setHours(
                        hours: number,
                        min?: number,
                        sec?: number,
                        ms?: number,
                    ): number;
                    setMilliseconds(ms: number): number;
                    setMinutes(min: number, sec?: number, ms?: number): number;
                    setMonth(month: number, date?: number): number;
                    setSeconds(sec: number, ms?: number): number;
                    setTime(time: number): number;
                    setUTCDate(date: number): number;
                    setUTCFullYear(year: number, month?: number, date?: number): number;
                    setUTCHours(
                        hours: number,
                        min?: number,
                        sec?: number,
                        ms?: number,
                    ): number;
                    setUTCMilliseconds(ms: number): number;
                    setUTCMinutes(min: number, sec?: number, ms?: number): number;
                    setUTCMonth(month: number, date?: number): number;
                    setUTCSeconds(sec: number, ms?: number): number;
                    toDateString(): string;
                    toISOString(): string;
                    toJSON(key?: any): string;
                    toLocaleDateString(): string;
                    toLocaleDateString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleDateString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleString(): string;
                    toLocaleString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleTimeString(): string;
                    toLocaleTimeString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleTimeString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toString(): string;
                    toTimeString(): string;
                    toUTCString(): string;
                    valueOf(): number;
                };
                ctimeMs: number;
                dev: number;
                gid: number;
                ino: number;
                mode: number;
                mtime: {
                    "[toPrimitive]"(hint: "default"): string;
                    "[toPrimitive]"(hint: "string"): string;
                    "[toPrimitive]"(hint: "number"): number;
                    "[toPrimitive]"(hint: string): string | number;
                    getDate(): number;
                    getDay(): number;
                    getFullYear(): number;
                    getHours(): number;
                    getMilliseconds(): number;
                    getMinutes(): number;
                    getMonth(): number;
                    getSeconds(): number;
                    getTime(): number;
                    getTimezoneOffset(): number;
                    getUTCDate(): number;
                    getUTCDay(): number;
                    getUTCFullYear(): number;
                    getUTCHours(): number;
                    getUTCMilliseconds(): number;
                    getUTCMinutes(): number;
                    getUTCMonth(): number;
                    getUTCSeconds(): number;
                    setDate(date: number): number;
                    setFullYear(year: number, month?: number, date?: number): number;
                    setHours(
                        hours: number,
                        min?: number,
                        sec?: number,
                        ms?: number,
                    ): number;
                    setMilliseconds(ms: number): number;
                    setMinutes(min: number, sec?: number, ms?: number): number;
                    setMonth(month: number, date?: number): number;
                    setSeconds(sec: number, ms?: number): number;
                    setTime(time: number): number;
                    setUTCDate(date: number): number;
                    setUTCFullYear(year: number, month?: number, date?: number): number;
                    setUTCHours(
                        hours: number,
                        min?: number,
                        sec?: number,
                        ms?: number,
                    ): number;
                    setUTCMilliseconds(ms: number): number;
                    setUTCMinutes(min: number, sec?: number, ms?: number): number;
                    setUTCMonth(month: number, date?: number): number;
                    setUTCSeconds(sec: number, ms?: number): number;
                    toDateString(): string;
                    toISOString(): string;
                    toJSON(key?: any): string;
                    toLocaleDateString(): string;
                    toLocaleDateString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleDateString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleString(): string;
                    toLocaleString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleTimeString(): string;
                    toLocaleTimeString(
                        locales?: string | string[],
                        options?: DateTimeFormatOptions,
                    ): string;
                    toLocaleTimeString(
                        locales?: LocalesArgument,
                        options?: DateTimeFormatOptions,
                    ): string;
                    toString(): string;
                    toTimeString(): string;
                    toUTCString(): string;
                    valueOf(): number;
                };
                mtimeMs: number;
                nlink: number;
                rdev: number;
                size: number;
                uid: number;
                isBlockDevice(): boolean;
                isCharacterDevice(): boolean;
                isDirectory(): boolean;
                isFIFO(): boolean;
                isFile(): boolean;
                isSocket(): boolean;
                isSymbolicLink(): boolean;
            };
        }[],
        unknown,
    >,
>
- Defined in src/functions/glob.mts:21
glob(
    source: string | readonly string[],
    options?: {
        absolute?: boolean;
        baseNameMatch?: boolean;
        braceExpansion?: boolean;
        caseSensitiveMatch?: boolean;
        concurrency?: number;
        cwd?: string;
        deep?: number;
        dot?: boolean;
        extglob?: boolean;
        followSymbolicLinks?: boolean;
        fs?: {
            lstat?: StatAsynchronousMethod;
            lstatSync?: StatSynchronousMethod;
            readdir?: ReaddirAsynchronousMethod;
            readdirSync?: ReaddirSynchronousMethod;
            stat?: StatAsynchronousMethod;
            statSync?: StatSynchronousMethod;
        };
        globstar?: boolean;
        ignore?: readonly string[];
        markDirectories?: boolean;
        objectMode?: boolean;
        onlyDirectories?: boolean;
        onlyFiles?: boolean;
        stats?: boolean;
        suppressErrors?: boolean;
        throwErrorOnBrokenSymbolicLink?: boolean;
        unique?: boolean;
    },
): Promise<Result<readonly string[], unknown>>
Parameters
- source: string | readonly string[]
- Optionaloptions: {
      absolute?: boolean;
      baseNameMatch?: boolean;
      braceExpansion?: boolean;
      caseSensitiveMatch?: boolean;
      concurrency?: number;
      cwd?: string;
      deep?: number;
      dot?: boolean;
      extglob?: boolean;
      followSymbolicLinks?: boolean;
      fs?: {
          lstat?: StatAsynchronousMethod;
          lstatSync?: StatSynchronousMethod;
          readdir?: ReaddirAsynchronousMethod;
          readdirSync?: ReaddirSynchronousMethod;
          stat?: StatAsynchronousMethod;
          statSync?: StatSynchronousMethod;
      };
      globstar?: boolean;
      ignore?: readonly string[];
      markDirectories?: boolean;
      objectMode?: boolean;
      onlyDirectories?: boolean;
      onlyFiles?: boolean;
      stats?: boolean;
      suppressErrors?: boolean;
      throwErrorOnBrokenSymbolicLink?: boolean;
      unique?: boolean;
  }
  - Optional Readonlyabsolute?: boolean
    Return the absolute path for entries.
    
    Default
    false
  - Optional ReadonlybaseNameMatch?: boolean
    If set to true, then patterns without slashes will be matched against the basename of the path if it contains slashes.
    
    Default
    false
  - Optional ReadonlybraceExpansion?: boolean
    Enables Bash-like brace expansion.
    
    Default
    true
  - Optional ReadonlycaseSensitiveMatch?: boolean
    Enables a case-sensitive mode for matching files.
    
    Default
    true
  - Optional Readonlyconcurrency?: number
    Specifies the maximum number of concurrent requests from a reader to read directories.
    
    Default
    os.cpus().length
  - Optional Readonlycwd?: string
    The current working directory in which to search.
    
    Default
    process.cwd()
  - Optional Readonlydeep?: number
    Specifies the maximum depth of a read directory relative to the start directory.
    
    Default
    Infinity
  - Optional Readonlydot?: boolean
    Allow patterns to match entries that begin with a period (.).
    
    Default
    false
  - Optional Readonlyextglob?: boolean
    Enables Bash-like extglob functionality.
    
    Default
    true
  - Optional ReadonlyfollowSymbolicLinks?: boolean
    Indicates whether to traverse descendants of symbolic link directories.
    
    Default
    true
  - Optional Readonlyfs?: {
        lstat?: StatAsynchronousMethod;
        lstatSync?: StatSynchronousMethod;
        readdir?: ReaddirAsynchronousMethod;
        readdirSync?: ReaddirSynchronousMethod;
        stat?: StatAsynchronousMethod;
        statSync?: StatSynchronousMethod;
    }
    Custom implementation of methods for working with the file system.
    
    Default
    fs.*
  - Optional Readonlyglobstar?: boolean
    Enables recursively repeats a pattern containing **. If false, ** behaves exactly like *.
    
    Default
    true
  - Optional Readonlyignore?: readonly string[]
    An array of glob patterns to exclude matches. This is an alternative way to use negative patterns.
    
    Default
    []
  - Optional ReadonlymarkDirectories?: boolean
    Mark the directory path with the final slash.
    
    Default
    false
  - Optional ReadonlyobjectMode?: boolean
    Returns objects (instead of strings) describing entries.
    
    Default
    false
  - Optional ReadonlyonlyDirectories?: boolean
    Return only directories.
    
    Default
    false
  - Optional ReadonlyonlyFiles?: boolean
    Return only files.
    
    Default
    true
  - Optional Readonlystats?: boolean
    Enables an object mode (objectMode) with an additional stats field.
    
    Default
    false
  - Optional ReadonlysuppressErrors?: boolean
    By default this package suppress only ENOENT errors. Set to true to suppress any error.
    
    Default
    false
  - Optional ReadonlythrowErrorOnBrokenSymbolicLink?: boolean
    Throw an error when symbolic link is broken if true or safely return lstat call if false.
    
    Default
    false
  - Optional Readonlyunique?: boolean
    Ensures that the returned entries are unique.
    
    Default
    true
Returns Promise<Result<readonly string[], unknown>>
- Defined in src/functions/glob.mts:26

Function glob

Parameters

Optional Readonlyabsolute?: boolean

Default

Optional ReadonlybaseNameMatch?: boolean

Default

Optional ReadonlybraceExpansion?: boolean

Default

Optional ReadonlycaseSensitiveMatch?: boolean

Default

Optional Readonlyconcurrency?: number

Default

Optional Readonlycwd?: string

Default

Optional Readonlydeep?: number

Default

Optional Readonlydot?: boolean

Default

Optional Readonlyextglob?: boolean

Default

Optional ReadonlyfollowSymbolicLinks?: boolean

Default

Optional Readonlyfs?: { lstat?: StatAsynchronousMethod; lstatSync?: StatSynchronousMethod; readdir?: ReaddirAsynchronousMethod; readdirSync?: ReaddirSynchronousMethod; stat?: StatAsynchronousMethod; statSync?: StatSynchronousMethod;}

Default

Optional Readonlyglobstar?: boolean

Default

Optional Readonlyignore?: readonly string[]

Default

Optional ReadonlymarkDirectories?: boolean

Default

Optional ReadonlyobjectMode?: boolean

Default

Optional ReadonlyonlyDirectories?: boolean

Default

Optional ReadonlyonlyFiles?: boolean

Default

Optional Readonlystats?: boolean

Default

Optional ReadonlysuppressErrors?: boolean

Default

Optional ReadonlythrowErrorOnBrokenSymbolicLink?: boolean

Default

Optional Readonlyunique?: boolean

Default

Parameters

Optional Readonlyabsolute?: boolean

Default

Optional ReadonlybaseNameMatch?: boolean

Default

Optional ReadonlybraceExpansion?: boolean

Default

Optional ReadonlycaseSensitiveMatch?: boolean

Default

Optional Readonlyconcurrency?: number

Default

Optional Readonlycwd?: string

Default

Optional Readonlydeep?: number

Default

Optional Readonlydot?: boolean

Default

Optional Readonlyextglob?: boolean

Default

Optional ReadonlyfollowSymbolicLinks?: boolean

Default

Optional Readonlyfs?: { lstat?: StatAsynchronousMethod; lstatSync?: StatSynchronousMethod; readdir?: ReaddirAsynchronousMethod; readdirSync?: ReaddirSynchronousMethod; stat?: StatAsynchronousMethod; statSync?: StatSynchronousMethod;}

Default

Optional Readonlyglobstar?: boolean

Default

Optional Readonlyignore?: readonly string[]

Default

Optional ReadonlymarkDirectories?: boolean

Default

Optional ReadonlyobjectMode?: boolean

Default

Optional ReadonlyonlyDirectories?: boolean

Default

Optional ReadonlyonlyFiles?: boolean

Default

Optional Readonlystats?: boolean

`Optional` `Readonly`absolute?: boolean

`Optional` `Readonly`baseNameMatch?: boolean

`Optional` `Readonly`braceExpansion?: boolean

`Optional` `Readonly`caseSensitiveMatch?: boolean

`Optional` `Readonly`concurrency?: number

`Optional` `Readonly`cwd?: string

`Optional` `Readonly`deep?: number

`Optional` `Readonly`dot?: boolean

`Optional` `Readonly`extglob?: boolean

`Optional` `Readonly`followSymbolicLinks?: boolean

`Optional` `Readonly`fs?: {
lstat?: StatAsynchronousMethod;
lstatSync?: StatSynchronousMethod;
readdir?: ReaddirAsynchronousMethod;
readdirSync?: ReaddirSynchronousMethod;
stat?: StatAsynchronousMethod;
statSync?: StatSynchronousMethod;
}

`Optional` `Readonly`globstar?: boolean

`Optional` `Readonly`ignore?: readonly string[]

`Optional` `Readonly`markDirectories?: boolean

`Optional` `Readonly`objectMode?: boolean

`Optional` `Readonly`onlyDirectories?: boolean

`Optional` `Readonly`onlyFiles?: boolean

`Optional` `Readonly`stats?: boolean

`Optional` `Readonly`suppressErrors?: boolean

`Optional` `Readonly`throwErrorOnBrokenSymbolicLink?: boolean

`Optional` `Readonly`unique?: boolean

`Optional` `Readonly`absolute?: boolean

`Optional` `Readonly`baseNameMatch?: boolean

`Optional` `Readonly`braceExpansion?: boolean

`Optional` `Readonly`caseSensitiveMatch?: boolean

`Optional` `Readonly`concurrency?: number

`Optional` `Readonly`cwd?: string

`Optional` `Readonly`deep?: number

`Optional` `Readonly`dot?: boolean

`Optional` `Readonly`extglob?: boolean

`Optional` `Readonly`followSymbolicLinks?: boolean

`Optional` `Readonly`fs?: {
lstat?: StatAsynchronousMethod;
lstatSync?: StatSynchronousMethod;
readdir?: ReaddirAsynchronousMethod;
readdirSync?: ReaddirSynchronousMethod;
stat?: StatAsynchronousMethod;
statSync?: StatSynchronousMethod;
}

`Optional` `Readonly`globstar?: boolean

`Optional` `Readonly`ignore?: readonly string[]

`Optional` `Readonly`markDirectories?: boolean

`Optional` `Readonly`objectMode?: boolean

`Optional` `Readonly`onlyDirectories?: boolean

`Optional` `Readonly`onlyFiles?: boolean

`Optional` `Readonly`stats?: boolean

`Optional` `Readonly`suppressErrors?: boolean

`Optional` `Readonly`throwErrorOnBrokenSymbolicLink?: boolean

`Optional` `Readonly`unique?: boolean