function

fs.globSync

pattern: string | readonly string[]

): string[];

When followSymlinks is enabled, detected symbolic link cycles are not traversed recursively.

import { globSync } from 'node:fs';

console.log(globSync('*.js'));

@returns

paths of files that match the pattern.

function globSync(

pattern: string | readonly string[],

options: GlobOptionsWithFileTypes

): Dirent<string>[];

When followSymlinks is enabled, detected symbolic link cycles are not traversed recursively.

import { globSync } from 'node:fs';

console.log(globSync('*.js'));

@returns

paths of files that match the pattern.

function globSync(

pattern: string | readonly string[],

options: GlobOptionsWithoutFileTypes

): string[];

When followSymlinks is enabled, detected symbolic link cycles are not traversed recursively.

import { globSync } from 'node:fs';

console.log(globSync('*.js'));

@returns

paths of files that match the pattern.

function globSync(

pattern: string | readonly string[],

options: GlobOptions

): string[] | Dirent<string>[];

When followSymlinks is enabled, detected symbolic link cycles are not traversed recursively.

import { globSync } from 'node:fs';

console.log(globSync('*.js'));

@returns

paths of files that match the pattern.

Referenced types

interface GlobOptionsWithFileTypes

cwd?: string | URL
Current working directory.
exclude?: readonly string[] | (fileName: Dirent) => boolean
Function to filter out files/directories or a list of glob patterns to be excluded. If a function is provided, return true to exclude the item, false to include it. If a string array is provided, each string should be a glob pattern that specifies paths to exclude. Note: Negation patterns (e.g., '!foo.js') are not supported.
followSymlinks?: boolean
When true, symbolic links to directories are followed while expanding ** patterns.
withFileTypes: true
true if the glob should return paths as Dirents, false otherwise.

class Dirent<Name extends string | Buffer = string>

A representation of a directory entry, which can be a file or a subdirectory within the directory, as returned by reading from an fs.Dir. The directory entry is a combination of the file name and file type pairs.

Additionally, when readdir or readdirSync is called with the withFileTypes option set to true, the resulting array is filled with fs.Dirent objects, rather than strings or Buffer s.

name: Name
The file name that this fs.Dirent object refers to. The type of this value is determined by the options.encoding passed to readdir or readdirSync.
parentPath: string
The path to the parent directory of the file this fs.Dirent object refers to.
isBlockDevice(): boolean;
Returns true if the fs.Dirent object describes a block device.
isCharacterDevice(): boolean;
Returns true if the fs.Dirent object describes a character device.
isDirectory(): boolean;
Returns true if the fs.Dirent object describes a file system directory.
isFIFO(): boolean;
Returns true if the fs.Dirent object describes a first-in-first-out (FIFO) pipe.
isFile(): boolean;
Returns true if the fs.Dirent object describes a regular file.
isSocket(): boolean;
Returns true if the fs.Dirent object describes a socket.
isSymbolicLink(): boolean;
Returns true if the fs.Dirent object describes a symbolic link.

interface GlobOptionsWithoutFileTypes

cwd?: string | URL
Current working directory.
exclude?: readonly string[] | (fileName: string) => boolean
Function to filter out files/directories or a list of glob patterns to be excluded. If a function is provided, return true to exclude the item, false to include it. If a string array is provided, each string should be a glob pattern that specifies paths to exclude. Note: Negation patterns (e.g., '!foo.js') are not supported.
followSymlinks?: boolean
When true, symbolic links to directories are followed while expanding ** patterns.
withFileTypes?: false
true if the glob should return paths as Dirents, false otherwise.

interface GlobOptions<T extends Dirent | string = Dirent | string>

cwd?: string | URL
Current working directory.
exclude?: readonly string[] | (fileName: T) => boolean
Function to filter out files/directories or a list of glob patterns to be excluded. If a function is provided, return true to exclude the item, false to include it. If a string array is provided, each string should be a glob pattern that specifies paths to exclude. Note: Negation patterns (e.g., '!foo.js') are not supported.
followSymlinks?: boolean
When true, symbolic links to directories are followed while expanding ** patterns.
withFileTypes?: boolean
true if the glob should return paths as Dirents, false otherwise.