UNPKG

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