reader-stream.d.ts 896 B

123456789101112131415161718192021222324252627
  1. /// <reference types="node" />
  2. import * as readdir from '@mrmlnc/readdir-enhanced';
  3. import Reader from './reader';
  4. import FileSystemStream from '../adapters/fs-stream';
  5. import { ITask } from '../managers/tasks';
  6. export default class ReaderStream extends Reader<NodeJS.ReadableStream> {
  7. /**
  8. * Returns FileSystem adapter.
  9. */
  10. readonly fsAdapter: FileSystemStream;
  11. /**
  12. * Use stream API to read entries for Task.
  13. */
  14. read(task: ITask): NodeJS.ReadableStream;
  15. /**
  16. * Returns founded paths.
  17. */
  18. api(root: string, task: ITask, options: readdir.Options): NodeJS.ReadableStream;
  19. /**
  20. * Api for dynamic tasks.
  21. */
  22. dynamicApi(root: string, options: readdir.Options): NodeJS.ReadableStream;
  23. /**
  24. * Api for static tasks.
  25. */
  26. staticApi(task: ITask, options: readdir.Options): NodeJS.ReadableStream;
  27. }