settings.d.ts 1.1 KB

123456789101112131415161718192021222324252627282930
  1. import * as fsScandir from '@nodelib/fs.scandir';
  2. import type { Entry, Errno } from './types';
  3. export declare type FilterFunction<T> = (value: T) => boolean;
  4. export declare type DeepFilterFunction = FilterFunction<Entry>;
  5. export declare type EntryFilterFunction = FilterFunction<Entry>;
  6. export declare type ErrorFilterFunction = FilterFunction<Errno>;
  7. export interface Options {
  8. basePath?: string;
  9. concurrency?: number;
  10. deepFilter?: DeepFilterFunction;
  11. entryFilter?: EntryFilterFunction;
  12. errorFilter?: ErrorFilterFunction;
  13. followSymbolicLinks?: boolean;
  14. fs?: Partial<fsScandir.FileSystemAdapter>;
  15. pathSegmentSeparator?: string;
  16. stats?: boolean;
  17. throwErrorOnBrokenSymbolicLink?: boolean;
  18. }
  19. export default class Settings {
  20. private readonly _options;
  21. readonly basePath?: string;
  22. readonly concurrency: number;
  23. readonly deepFilter: DeepFilterFunction | null;
  24. readonly entryFilter: EntryFilterFunction | null;
  25. readonly errorFilter: ErrorFilterFunction | null;
  26. readonly pathSegmentSeparator: string;
  27. readonly fsScandirSettings: fsScandir.Settings;
  28. constructor(_options?: Options);
  29. private _getValue;
  30. }