Function scan

  • Returns the Directory Tree of a given path. This function in synchronous.

    Parameters

    • path: string

      The path which you want to inspect

    • Optional options: ScanOptions

      An object used as options of the function

    • Optional onFile: Callback

      A function called when a file is added - has the tree object and its stat as parameters

    • Optional onDir: Callback

      A function called when a dir is added - has the tree object and its stat as parameters

    Returns Dree

    The directory tree as a Dree object

Settings

Member Visibility

Theme

Generated using TypeDoc