Interface Dree

Interface of an object representing a Directory Tree

interface Dree {
    children?: Dree[];
    descendants?: number;
    extension?: string;
    hash?: string;
    isEmpty?: boolean;
    isSymbolicLink: boolean;
    name: string;
    path: string;
    relativePath: string;
    size?: string;
    sizeInBytes?: number;
    stat?: Stats;
    type: Type;
}

Properties

children? descendants? extension? hash? isEmpty? isSymbolicLink name path relativePath size? sizeInBytes? stat? type

Properties

Optional children

children?: Dree[]

Optional. An array of Dree objects, containing all the children of the node

Optional descendants

descendants?: number

Optional. The number of descendants of the node. Returned only if the node is a directory and [[descendants]] option is specified

Optional extension

extension?: string

Optional. The extension (without dot) of the node. Returned only if the node is a file

Optional hash

hash?: string

Optional. The hash of the node

Optional isEmpty

isEmpty?: boolean

Optional. True if the node is a directory and contains no files and no directories

isSymbolicLink

isSymbolicLink: boolean

A boolean with true value if the node is a symbolic link

name

name: string

The name of the node as a string

path

path: string

The absolute path of the node

relativePath

relativePath: string

The relative path from the root of the node

Optional size

size?: string

Optional. The size of the node, rounded to two decimals and appropriate unit

Optional sizeInBytes

sizeInBytes?: number

Optional. The size in bytes of the node

Optional stat

stat?: Stats

Optional. The fs.lstat or fs.fstat of the node

type

type: Type

Values: Type.DIRECTORY or Type.FILE

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc