Options
All
  • Public
  • Public/Protected
  • All
Menu

fast-traverse — Reference

Index

Interfaces

Type aliases

Functions

Type aliases

MaybePromise

MaybePromise<Value>: Value | Promise<Value>

Type parameters

  • Value

Return

Return<BaseName, DirName, DirectoryList>: AsyncGenerator<Item<BaseName, DirName, DirectoryList>>

Type parameters

  • BaseName

  • DirName

  • DirectoryList

Functions

Const DEFAULT_DEEP

  • DEFAULT_DEEP(): true

traverse

  • traverse<DirectoryList, Path, BaseName>(options: Options<DirectoryList, Path, BaseName>): Return<BaseName | undefined, Path, DirectoryList>

  • Type parameters

    • DirectoryList: Iterable<BaseName>

    • Path = string

    • BaseName = Path

    Parameters

    • options: Options<DirectoryList, Path, BaseName>

    Returns Return<BaseName | undefined, Path, DirectoryList>

Generated using TypeDoc