Interface ScanOptions

memberof: fsn/nextra
property: {Function} [filter] A filter function receiving (dirent, path) to determine if the returned map should include a given entry
property: {number} [depthLimit] How many directories deep the scan should go (0 is just the children of the passed root directory, no subdirectory files)

Hierarchy

ScanOptions

Index

Properties

Properties

Optional depthLimit

depthLimit: number

Optional filter

filter: (dirent: Dirent, path: string) => boolean

Type declaration

- (dirent: Dirent, path: string): boolean
- Parameters
  - dirent: Dirent
  - path: string
  Returns boolean

Generated using TypeDoc