Function __promisify__

  • __promisify__(path: PathLike, options?: null | BufferEncoding | {
        encoding: null | BufferEncoding;
        withFileTypes?: false;
    }): Promise<string[]>

  • 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.

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

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

    Returns Promise<string[]>

  • __promisify__(path: PathLike, options: "buffer" | {
        encoding: "buffer";
        withFileTypes?: false;
    }): Promise<Buffer[]>

  • 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.

    Returns Promise<Buffer[]>

  • __promisify__(path: PathLike, options?: null | BufferEncoding | ObjectEncodingOptions & {
        withFileTypes?: false;
    }): Promise<string[] | Buffer[]>

  • 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.

    • Optional options: 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.

    Returns Promise<string[] | Buffer[]>

  • __promisify__(path: PathLike, options: ObjectEncodingOptions & {
        withFileTypes: true;
    }): Promise<Dirent[]>

  • 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

    Returns Promise<Dirent[]>

Settings

Member Visibility

Theme