Function readdir

readdir(
    this: V_Context,
    path: PathLike,
    options?:
        | null
        | BufferEncoding
        | ObjectEncodingOptions & { recursive?: boolean; withFileTypes?: false },
): Promise<string[]>
Asynchronous readdir(3) - read a directory.

Note: The order of entries is not guaranteed
Parameters
- this: V_Context
- path: PathLike
  A path to a file. If a URL is provided, it must use the file: protocol.
- Optionaloptions:
      | null
      | 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'.
Returns Promise<string[]>
- Defined in src/vfs/promises.ts:842
readdir(
    this: V_Context,
    path: PathLike,
    options:
        | "buffer"
        | { encoding: "buffer"; recursive?: boolean; withFileTypes?: false },
): Promise<Buffer<ArrayBufferLike>[]>
Asynchronous readdir(3) - read a directory.

Note: The order of entries is not guaranteed
Parameters
- this: V_Context
- 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'.
Returns Promise<Buffer<ArrayBufferLike>[]>
- Defined in src/vfs/promises.ts:847
readdir(
    this: V_Context,
    path: PathLike,
    options?:
        | null
        | BufferEncoding
        | ObjectEncodingOptions & { recursive?: boolean; withFileTypes?: false },
): Promise<string[] | Buffer<ArrayBufferLike>[]>
Asynchronous readdir(3) - read a directory.

Note: The order of entries is not guaranteed
Parameters
- this: V_Context
- path: PathLike
  A path to a file. If a URL is provided, it must use the file: protocol.
- Optionaloptions:
      | null
      | 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'.
Returns Promise<string[] | Buffer<ArrayBufferLike>[]>
- Defined in src/vfs/promises.ts:852
readdir(
    this: V_Context,
    path: PathLike,
    options: ObjectEncodingOptions & {
        recursive?: boolean;
        withFileTypes: true;
    },
): Promise<Dirent<string>[]>
Asynchronous readdir(3) - read a directory.

Note: The order of entries is not guaranteed
Parameters
- this: V_Context
- path: PathLike
  A path to a file. If a URL is provided, it must use the file: protocol.
- options: ObjectEncodingOptions & { recursive?: boolean; withFileTypes: true }
  The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8'.
Returns Promise<Dirent<string>[]>
- Defined in src/vfs/promises.ts:857
readdir(
    this: V_Context,
    path: PathLike,
    options: { encoding: "buffer"; recursive?: boolean; withFileTypes: true },
): Promise<Dirent<Buffer<ArrayBufferLike>>[]>
Asynchronous readdir(3) - read a directory.

Note: The order of entries is not guaranteed
Parameters
- this: V_Context
- 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 }
  The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8'.
Returns Promise<Dirent<Buffer<ArrayBufferLike>>[]>
- Defined in src/vfs/promises.ts:862
readdir(
    this: V_Context,
    path: PathLike,
    options?: ReaddirOptions,
): Promise<string[] | Buffer<ArrayBufferLike>[] | Dirent<any>[]>
Asynchronous readdir(3) - read a directory.

Note: The order of entries is not guaranteed
Parameters
- this: V_Context
- path: PathLike
  A path to a file. If a URL is provided, it must use the file: protocol.
- Optionaloptions: ReaddirOptions
  The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8'.
Returns Promise<string[] | Buffer<ArrayBufferLike>[] | Dirent<any>[]>
- Defined in src/vfs/promises.ts:867

Function readdir

Parameters

Returns Promise<string[]>

Parameters

Returns Promise<Buffer<ArrayBufferLike>[]>

Parameters

Returns Promise<string[] | Buffer<ArrayBufferLike>[]>

Parameters

Returns Promise<Dirent<string>[]>

Parameters

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

Parameters

Returns Promise<string[] | Buffer<ArrayBufferLike>[] | Dirent<any>[]>

Settings