Function readdir

readdir(path: PathLike, options: undefined | null | BufferEncoding | {
encoding: null | BufferEncoding;
withFileTypes?: false;
}, callback: ((err: null | ErrnoException, files: string[]) => void)): void
Reads the contents of a directory. The callback gets two arguments (err, files)where files is an array of the names of the files in the directory excluding'.' and '..'.

See the POSIX readdir(3) documentation for more details.

The optional options argument can be a string specifying an encoding, or an object with an encoding property specifying the character encoding to use for the filenames passed to the callback. If the encoding is set to 'buffer', the filenames returned will be passed as Buffer objects.

If options.withFileTypes is set to true, the files array will contain fs.Dirent objects.

Since
v0.1.8
Parameters
- path: PathLike
- options: undefined | null | BufferEncoding | {
  encoding: null | BufferEncoding;
  withFileTypes?: false;
  }
- callback: ((err: null | ErrnoException, files: string[]) => void)
  - - (err: null | ErrnoException, files: string[]): void
    - Parameters
      
      err: null | ErrnoException
      
      files: string[]
      
      Returns void
Returns void
- Defined in node_modules/@types/node/fs.d.ts:1778
readdir(path: PathLike, options: "buffer" | {
encoding: "buffer";
withFileTypes?: false;
}, callback: ((err: null | ErrnoException, files: Buffer[]) => void)): void
Asynchronous readdir(3) - read a directory.
Parameters
- path: PathLike
  
  A path to a file. If a URL is provided, it must use the file: protocol.
- options: "buffer" | {
  encoding: "buffer";
  withFileTypes?: false;
  }
  
  The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
- callback: ((err: null | ErrnoException, files: Buffer[]) => void)
  - - (err: null | ErrnoException, files: Buffer[]): void
    - Parameters
      
      err: null | ErrnoException
      
      files: Buffer[]
      
      Returns void
Returns void
- Defined in node_modules/@types/node/fs.d.ts:1795
readdir(path: PathLike, options: undefined | null | BufferEncoding | ObjectEncodingOptions & {
withFileTypes?: false;
}, callback: ((err: null | ErrnoException, files: string[] | Buffer[]) => void)): void
Asynchronous readdir(3) - read a directory.
Parameters
- path: PathLike
  
  A path to a file. If a URL is provided, it must use the file: protocol.
- options: undefined | null | BufferEncoding | ObjectEncodingOptions & {
  withFileTypes?: false;
  }
  
  The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
- callback: ((err: null | ErrnoException, files: string[] | Buffer[]) => void)
  - - (err: null | ErrnoException, files: string[] | Buffer[]): void
    - Parameters
      
      err: null | ErrnoException
      
      files: string[] | Buffer[]
      
      Returns void
Returns void
- Defined in node_modules/@types/node/fs.d.ts:1810
readdir(path: PathLike, callback: ((err: null | ErrnoException, files: string[]) => void)): void
Asynchronous readdir(3) - read a directory.
Parameters
- path: PathLike
  
  A path to a file. If a URL is provided, it must use the file: protocol.
- callback: ((err: null | ErrnoException, files: string[]) => void)
  - - (err: null | ErrnoException, files: string[]): void
    - Parameters
      
      err: null | ErrnoException
      
      files: string[]
      
      Returns void
Returns void
- Defined in node_modules/@types/node/fs.d.ts:1825
readdir(path: PathLike, options: ObjectEncodingOptions & {
withFileTypes: true;
}, callback: ((err: null | ErrnoException, files: Dirent[]) => void)): void
Asynchronous readdir(3) - read a directory.
Parameters
- path: PathLike
  
  A path to a file. If a URL is provided, it must use the file: protocol.
- options: ObjectEncodingOptions & {
  withFileTypes: true;
  }
  
  If called with withFileTypes: true the result data will be an array of Dirent.
- callback: ((err: null | ErrnoException, files: Dirent[]) => void)
  - - (err: null | ErrnoException, files: Dirent[]): void
    - Parameters
      
      err: null | ErrnoException
      
      files: Dirent[]
      
      Returns void
Returns void
- Defined in node_modules/@types/node/fs.d.ts:1831

Function readdir

Since

Parameters

path: PathLike

options: undefined | null | BufferEncoding | { encoding: null | BufferEncoding; withFileTypes?: false; }

callback: ((err: null | ErrnoException, files: string[]) => void)

Parameters

err: null | ErrnoException

files: string[]

Returns void

Returns void

Parameters

path: PathLike

options: "buffer" | { encoding: "buffer"; withFileTypes?: false; }

callback: ((err: null | ErrnoException, files: Buffer[]) => void)

Parameters

err: null | ErrnoException

files: Buffer[]

Returns void

Returns void

Parameters

path: PathLike

options: undefined | null | BufferEncoding | ObjectEncodingOptions & { withFileTypes?: false; }

callback: ((err: null | ErrnoException, files: string[] | Buffer[]) => void)

Parameters

err: null | ErrnoException

files: string[] | Buffer[]

Returns void

Returns void

Parameters

path: PathLike

callback: ((err: null | ErrnoException, files: string[]) => void)

Parameters

err: null | ErrnoException

files: string[]

Returns void

Returns void

Parameters

path: PathLike

options: ObjectEncodingOptions & { withFileTypes: true; }

callback: ((err: null | ErrnoException, files: Dirent[]) => void)

Parameters

err: null | ErrnoException

files: Dirent[]

Returns void

Returns void

Settings

Member Visibility

Theme

options: undefined | null | BufferEncoding | {
encoding: null | BufferEncoding;
withFileTypes?: false;
}

options: "buffer" | {
encoding: "buffer";
withFileTypes?: false;
}

options: undefined | null | BufferEncoding | ObjectEncodingOptions & {
withFileTypes?: false;
}

options: ObjectEncodingOptions & {
withFileTypes: true;
}