Function readdirSync

  • readdirSync(path, options?): string[]

  • Synchronous readdir. Reads the contents of a directory.

    Parameters

    • path: PathLike
    • Optional options: null | BufferEncoding | {
          encoding?: BufferEncoding | null | undefined;
          recursive?: boolean;
          withFileTypes?: false;
      }

    Returns string[]

  • readdirSync(path, options): Buffer[]

  • Parameters

    • path: PathLike
    • options: "buffer" | {
          encoding: "buffer";
          recursive?: boolean;
          withFileTypes?: false;
      }

    Returns Buffer[]

  • readdirSync(path, options): Dirent[]

  • Parameters

    • path: PathLike
    • options: {
          recursive?: boolean;
          withFileTypes: true;
      }
      • Optional recursive?: boolean
      • withFileTypes: true

    Returns Dirent[]

  • readdirSync(path, options?): string[] | Buffer[]

  • Parameters

    • path: PathLike
    • Optional options: null | BufferEncoding | ObjectEncodingOptions & {
          recursive?: boolean;
          withFileTypes?: false;
      }

    Returns string[] | Buffer[]

Settings

Member Visibility

Theme