Project parrier

default

• default(path?: string, options?: { recurse: boolean }): Promise<IFile[]>

• Lists everything inside the provided "path" (or the full tree structure if "recurse" is set), asynchronously.

  example

  // common usage:
  // prints files & folders inside path
  parrier('the/path/').then(console.log);
  

  example

  // Recursive usage:
  // prints full tree structure
  parrier('the/path/', { recurse: true }).then(console.log);
  

  example

  // Getting './' content:
  // prints files & folders inside './'
  parrier().then(console.log);
  

  Parameters

  • path: string = './'

    The path from where to get content

  • options: { recurse: boolean } = ...

    The options input

    • recurse: boolean

      The recurse option which lets us get full tree

  Returns Promise<IFile[]>