Convert docs to docsy

This commit is contained in:
Phillip Wittrock
2020-06-07 21:07:46 -07:00
parent 25a38ad2b6
commit 42497c664f
11469 changed files with 816051 additions and 4557 deletions

View File

@@ -0,0 +1,20 @@
/// <reference types="node" />
import * as fs from 'fs';
import FileSystem from './fs';
import { FilterFunction } from '@mrmlnc/readdir-enhanced';
import { Entry } from '../types/entries';
import { Pattern } from '../types/patterns';
export default class FileSystemStream extends FileSystem<NodeJS.ReadableStream> {
/**
* Use stream API to read entries for Task.
*/
read(patterns: string[], filter: FilterFunction): NodeJS.ReadableStream;
/**
* Return entry for the provided path.
*/
getEntry(filepath: string, pattern: Pattern): Promise<Entry | null>;
/**
* Return fs.Stats for the provided path.
*/
getStat(filepath: string): Promise<fs.Stats>;
}