index.d.ts 789 B

123456789101112131415161718192021
  1. /// <reference types="node" />
  2. import { IPartialOptions } from './managers/options';
  3. import { ITask } from './managers/tasks';
  4. import { EntryItem } from './types/entries';
  5. import { Pattern } from './types/patterns';
  6. /**
  7. * Synchronous API.
  8. */
  9. export declare function sync(source: Pattern | Pattern[], opts?: IPartialOptions): EntryItem[];
  10. /**
  11. * Asynchronous API.
  12. */
  13. export declare function async(source: Pattern | Pattern[], opts?: IPartialOptions): Promise<EntryItem[]>;
  14. /**
  15. * Stream API.
  16. */
  17. export declare function stream(source: Pattern | Pattern[], opts?: IPartialOptions): NodeJS.ReadableStream;
  18. /**
  19. * Return a set of tasks based on provided patterns.
  20. */
  21. export declare function generateTasks(source: Pattern | Pattern[], opts?: IPartialOptions): ITask[];