@typhonjs-utils/file-util
  • @typhonjs-utils/file-util
  • walkFiles

Function walkFiles

  • walkFiles(options?): AsyncGenerator<string, void, unknown>
  • A generator function that walks the local file tree.

    Parameters

    • Optional options: {
          dir?: string;
          excludeDir?: ConditionTest;
          excludeFile?: ConditionTest;
          includeDir?: ConditionTest;
          includeFile?: ConditionTest;
          walk?: boolean;
      }

      Options.

      • Optional dir?: string

        The directory to start walking; default is CWD / ..

      • Optional excludeDir?: ConditionTest

        A ConditionTest defining directory names to exclude.

      • Optional excludeFile?: ConditionTest

        A ConditionTest defining file names to exclude.

      • Optional includeDir?: ConditionTest

        A ConditionTest defining directory names to include.

      • Optional includeFile?: ConditionTest

        A ConditionTest defining file names to include.

      • Optional walk?: boolean

        When true subdirectories are walked.

    Returns AsyncGenerator<string, void, unknown>

    Generator

    Yields

Settings

Member Visibility

Theme

@typhonjs-utils/file-util
  • @typhonjs-utils/file-util
  • @typhonjs-utils/file-util/plugin