Function forEachChild

  • forEachChild(path, options, func): Promise<void>

  • Iterate through every child of a folder, asynchronously. This function will not recurse into subdirectories.

    Parameters

    • path: string

      folder path to iterate through

    • options: undefined | null | BufferEncoding | {
          encoding: BufferEncoding | null;
      } | Record<string, never>

      options to pass through to [[readdir]]

    • func: ((filename) => void | Promise<void>)

      iterate function, called for every child

        • (filename): void | Promise<void>

        • Parameters

          • filename: string

          Returns void | Promise<void>

    Returns Promise<void>

  • forEachChild(path, options, func): Promise<void>

  • Parameters

    • path: string
    • options: {
          encoding: "buffer";
      } | "buffer"
    • func: ((filename) => void | Promise<void>)
        • (filename): void | Promise<void>

        • Parameters

          Returns void | Promise<void>

    Returns Promise<void>

  • forEachChild(path, func): Promise<void>

  • Parameters

    • path: string
    • func: ((filename) => void | Promise<void>)
        • (filename): void | Promise<void>

        • Parameters

          • filename: string

          Returns void | Promise<void>

    Returns Promise<void>

  • forEachChild(path, options, func, callback): void

  • Parameters

    • path: string
    • options: undefined | null | BufferEncoding | Record<string, never> | {
          encoding: BufferEncoding | null;
      }
    • func: ((filename) => void)
        • (filename): void

        • Parameters

          • filename: string

          Returns void

    • callback: ErrorCallback

    Returns void

  • forEachChild(path, options, func, callback): void

  • Parameters

    • path: string
    • options: "buffer" | {
          encoding: "buffer";
      }
    • func: ((filename) => void)
        • (filename): void

        • Parameters

          Returns void

    • callback: ErrorCallback

    Returns void

  • forEachChild(path, func, callback): void

  • Parameters

    • path: string
    • func: ((filename) => void)
        • (filename): void

        • Parameters

          • filename: string

          Returns void

    • callback: ErrorCallback

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc