Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OptionsParameters

Hierarchy

  • OptionsParameters

Index

Properties

Optional excludedDirs

excludedDirs?: string[]

An array of excluded dirs. Similar to isExcludedDir but without the hassle fo creating a predicate. Just give it a list of dirs to be excluded.

Optional resolve

resolve?: boolean

Whether to resolve paths to absolute paths (relative to process.cwd()).

Methods

Optional isExcludedDir

  • isExcludedDir(dirname: string): boolean
  • A predicate that determines whether the directory with the given dirname should be crawled.

    There is no isExcludedFile option because you can exclude files by checking conditions while lazily iterating usinggetAllFiles.sync or getAllFiles.async

    Parameters

    • dirname: string

    Returns boolean

Generated using TypeDoc