file.d.ts 555 B

1234567891011121314151617
  1. /// <reference types="node" />
  2. /// <reference types="node" />
  3. import { Readable } from 'stream';
  4. import { Stats, createReadStream } from 'fs';
  5. import { GetUriProtocol } from './';
  6. type ReadStreamOptions = NonNullable<Exclude<Parameters<typeof createReadStream>[1], string>>;
  7. interface FileReadable extends Readable {
  8. stat?: Stats;
  9. }
  10. export interface FileOptions extends ReadStreamOptions {
  11. cache?: FileReadable;
  12. }
  13. /**
  14. * Returns a `fs.ReadStream` instance from a "file:" URI.
  15. */
  16. export declare const file: GetUriProtocol<FileOptions>;
  17. export {};