Class DirectoryList

Wrapper for directory structure in filesystem. May be recursive

Hierarchy

DirectoryList

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new DirectoryList(instance?: DirectoryList): DirectoryList
new DirectoryList(name: string, struct: (string | DirectoryList)[]): DirectoryList
new DirectoryList(name: string, struct: (string | DirectoryList)[], stats: Stats): DirectoryList

- Defined in DirectoryList.ts:37
Parameters
- Optional instance: DirectoryList
Returns DirectoryList
- Defined in DirectoryList.ts:38
Parameters
- name: string
- struct: (string | DirectoryList)[]
Returns DirectoryList
- Defined in DirectoryList.ts:39
Parameters
- name: string
- struct: (string | DirectoryList)[]
- stats: Stats
Returns DirectoryList

Accessors

name

get name(): string
set name(name: string): void

- Defined in DirectoryList.ts:22
Returns string
- Defined in DirectoryList.ts:25
Parameters
- name: string
Returns void

stats

get stats(): undefined | Stats

- Defined in DirectoryList.ts:33
Stats info of directory.

see
{@link Stats NodeJS.fs.Stats}

Returns undefined | Stats

Methods

[iterator]

[iterator](): Iterator<string | DirectoryList, any, undefined>

- Defined in DirectoryList.ts:59
Returns Iterator<string | DirectoryList, any, undefined>

[toPrimitive]

[toPrimitive](hint: TypeOfTag): string | void

- Defined in DirectoryList.ts:63
Parameters
- hint: TypeOfTag
Returns string | void

get

get(fullname?: boolean): DirectoryListJSONContent

- Defined in DirectoryList.ts:103
Get JSON representation of inner directory structure on filesystem

Parameters
- fullname: boolean = false
Returns DirectoryListJSONContent

toJSON

toJSON(fullname?: boolean, root?: boolean): DirectoryListJSON

- Defined in DirectoryList.ts:114
Prefered method to serialize instance

since
1.3.0

Parameters
- fullname: boolean = false
- root: boolean = true
Returns DirectoryListJSON

toString

toString(): string

- Defined in DirectoryList.ts:98
Returns string

Generated using TypeDoc