fs-tree-diff
- Version 2.0.1
- Published
- 41.5 kB
- 5 dependencies
- MIT license
Install
npm i fs-tree-diff
yarn add fs-tree-diff
pnpm add fs-tree-diff
Overview
Backs out file tree changes
Index
Classes
class FSTree
class FSTree<T extends BaseEntry = DefaultEntry> {}
constructor
constructor(options?: { entries?: T[]; sortAndExpand?: boolean });
property entries
entries: T[];
property size
readonly size: number;
method addEntries
addEntries: (entries: T[], options?: FSTree.StaticOptions) => void;
method addPaths
addPaths: (paths: string[], options?: FSTree.StaticOptions) => void;
method applyPatch
static applyPatch: ( input: string, output: string, patch: FSTree.Patch, _delegate?: FSTree.PatchDelegate) => void;
method calculateAndApplyPatch
calculateAndApplyPatch: ( otherFSTree: FSTree<T>, input: string, output: string, delegate?: FSTree.PatchDelegate) => void;
method calculatePatch
calculatePatch: <K extends BaseEntry>( theirFSTree: FSTree<K>, isEqual?: (a: T, b: K) => boolean) => FSTree.Patch;
method defaultIsEqual
static defaultIsEqual: (entryA: DefaultEntry, entryB: DefaultEntry) => boolean;
method forEach
forEach: ( fn: (entry: T, index: number, collection: T[]) => void, context: any) => void;
method fromEntries
static fromEntries: <T extends BaseEntry>( entries: T[], options?: FSTree.StaticOptions) => FSTree<T>;
method fromPaths
static fromPaths: ( paths: string[], options?: FSTree.StaticOptions) => FSTree<Entry>;
Interfaces
interface Options
interface Options {}
property entries
entries?: BaseEntry[];
property sortAndExpand
sortAndExpand?: boolean;
interface PatchDelegate
interface PatchDelegate {}
method change
change: (inputPath: string, outputPath: string, relativePath: string) => void;
method create
create: (inputPath: string, outputPath: string, relativePath: string) => void;
method mkdir
mkdir: (inputPath: string, outputPath: string, relativePath: string) => void;
method rmdir
rmdir: (inputPath: string, outputPath: string, relativePath: string) => void;
method unlink
unlink: (inputPath: string, outputPath: string, relativePath: string) => void;
interface StaticOptions
interface StaticOptions {}
property sortAndExpand
sortAndExpand?: boolean;
Type Aliases
Package Files (1)
Dependencies (5)
Dev Dependencies (9)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/fs-tree-diff
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/fs-tree-diff)
- HTML<a href="https://www.jsdocs.io/package/fs-tree-diff"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 1397 ms. - Missing or incorrect documentation? Open an issue for this package.