@haxall/haxall
    Preparing search index...

    Function __promisify__

    • __promisify__(
          path: PathLike,
          options?:
              | BufferEncoding
              | { encoding: BufferEncoding; recursive?: boolean; 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.

      • Optionaloptions:
            | BufferEncoding
            | { encoding: BufferEncoding; recursive?: boolean; 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"; recursive?: boolean; withFileTypes?: false },
      ): Promise<Buffer<ArrayBufferLike>[]>

      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"; recursive?: boolean; 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<ArrayBufferLike>[]>

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

      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.

      • Optionaloptions:
            | BufferEncoding
            | ObjectEncodingOptions & { recursive?: boolean; 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<ArrayBufferLike>[]>

    • __promisify__(
          path: PathLike,
          options: ObjectEncodingOptions & {
              recursive?: boolean;
              withFileTypes: true;
          },
      ): Promise<Dirent<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.

      • options: ObjectEncodingOptions & { recursive?: boolean; withFileTypes: true }

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

      Returns Promise<Dirent<string>[]>

    • __promisify__(
          path: PathLike,
          options: { encoding: "buffer"; recursive?: boolean; withFileTypes: true },
      ): Promise<Dirent<Buffer<ArrayBufferLike>>[]>

      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: { encoding: "buffer"; recursive?: boolean; withFileTypes: true }

        Must include withFileTypes: true and encoding: 'buffer'.

      Returns Promise<Dirent<Buffer<ArrayBufferLike>>[]>

    Settings

    Member Visibility