Module readdir

Callable

• readdir(path: PathLike, options: object | BufferEncoding | undefined | null, callback: function): void
• readdir(path: PathLike, options: object | "buffer", callback: function): void
• readdir(path: PathLike, options: object | string | undefined | null, callback: function): void
• readdir(path: PathLike, callback: function): void
• readdir(path: PathLike, options: object, callback: function): 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: object | BufferEncoding | undefined | null

    The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

  • callback: function

    • • (err: ErrnoException | null, files: string[]): void

      • Parameters

        • err: ErrnoException | null

        • files: string[]

        Returns void

  Returns 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: object | "buffer"

    The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

  • callback: function

    • • (err: ErrnoException | null, files: Buffer[]): void

      • Parameters

        • err: ErrnoException | null

        • files: Buffer[]

        Returns void

  Returns 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: object | string | undefined | null

    The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

  • callback: function

    • • (err: ErrnoException | null, files: string[] | Buffer[]): void

      • Parameters

        • err: ErrnoException | null

        • files: string[] | Buffer[]

        Returns void

  Returns 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: function

    • • (err: ErrnoException | null, files: string[]): void

      • Parameters

        • err: ErrnoException | null

        • files: string[]

        Returns void

  Returns 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: object

    If called with withFileTypes: true the result data will be an array of Dirent.

    • Optional encoding?: string | null

    • withFileTypes: true

  • callback: function

    • • (err: ErrnoException | null, files: Dirent[]): void

      • Parameters

        • err: ErrnoException | null

        • files: Dirent[]

        Returns void

  Returns void