Skip to content

Commit

Permalink
encapsulated additional custom properties to parent field "custom"
Browse files Browse the repository at this point in the history
  • Loading branch information
lukasrandom committed Jan 30, 2022
1 parent a555442 commit af10d08
Showing 1 changed file with 26 additions and 22 deletions.
48 changes: 26 additions & 22 deletions index.d.ts
@@ -1,33 +1,37 @@
import { Stats } from 'fs';

declare function directoryTree(
path: string,
options ? : directoryTree.DirectoryTreeOptions,
onEachFile ? : directoryTree.DirectoryTreeCallback,
onEachDirectory ? : directoryTree.DirectoryTreeCallback,
path: string,
options?: directoryTree.DirectoryTreeOptions,
onEachFile?: directoryTree.DirectoryTreeCallback,
onEachDirectory?: directoryTree.DirectoryTreeCallback
): directoryTree.DirectoryTree;

export as namespace directoryTree;

declare namespace directoryTree {
export interface DirectoryTree {
path: string;
name: string;
size: number;
type: "directory" | "file";
children ? : DirectoryTree[];
extension?: string;
isSymbolicLink?: boolean;
[key: string]: any;
}
export interface DirectoryTreeOptions {
normalizePath ? : boolean;
exclude ? : RegExp | RegExp[];
attributes ? : (keyof Stats | "type" | "extension")[];
extensions ? : RegExp;
followSymlink ? : boolean;
}
export type DirectoryTreeCallback = (item: DirectoryTree, path: string, stats: Stats) => void;
export interface DirectoryTree {
path: string;
name: string;
size: number;
type: 'directory' | 'file';
children?: DirectoryTree[];
extension?: string;
isSymbolicLink?: boolean;
custom: { [key: string]: any };
}
export interface DirectoryTreeOptions {
normalizePath?: boolean;
exclude?: RegExp | RegExp[];
attributes?: (keyof Stats | 'type' | 'extension')[];
extensions?: RegExp;
followSymlink?: boolean;
}
export type DirectoryTreeCallback = (
item: DirectoryTree,
path: string,
stats: Stats
) => void;
}

export = directoryTree;

0 comments on commit af10d08

Please sign in to comment.