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,27 @@
import * as readdir from '@mrmlnc/readdir-enhanced';
import Reader from './reader';
import FileSystemSync from '../adapters/fs-sync';
import { ITask } from '../managers/tasks';
import { Entry, EntryItem } from '../types/entries';
export default class ReaderSync extends Reader<EntryItem[]> {
/**
* Returns FileSystem adapter.
*/
readonly fsAdapter: FileSystemSync;
/**
* Use sync API to read entries for Task.
*/
read(task: ITask): EntryItem[];
/**
* Returns founded paths.
*/
api(root: string, task: ITask, options: readdir.Options): Entry[];
/**
* Api for dynamic tasks.
*/
dynamicApi(root: string, options: readdir.Options): Entry[];
/**
* Api for static tasks.
*/
staticApi(task: ITask, options: readdir.Options): Entry[];
}