Class DirectoryInfo<F, A, FA>

Type Parameters

F extends FileInfo<FA>
A extends object = any
FA extends object = any

Hierarchy (View Summary)

DataInfo<A>
- DirectoryInfo

Index

Constructors

Properties

_attributes? _entries _hash? _name _path _size _type

Accessors

attributes entries hash name path size type

Methods

addEntries clone extractFolderName fromFolderObject

Constructors

constructor

new DirectoryInfo<
    F extends FileInfo<FA>,
    A extends object = any,
    FA extends object = any,
>(
    path: string,
    size?: number,
): DirectoryInfo<F, A, FA>
Type Parameters
- F extends FileInfo<FA>
- A extends object = any
- FA extends object = any
Parameters
- path: string
- Optionalsize: number
Returns DirectoryInfo<F, A, FA>
Overrides DataInfo.constructor
- Defined in data-info/directory-info.ts:11

Properties

`Protected` `Optional`_attributes

_attributes?: A

`Protected`_entries

_entries: (F | DirectoryInfo<F, A, FA>)[] = []

`Protected` `Optional`_hash

_hash?: string

`Protected`_name

_name: string

`Protected` `Readonly`_path

_path: string

`Protected`_size

_size: number

`Protected`_type

_type: string

Accessors

attributes

get attributes(): undefined | T
Returns undefined | T
Inherited from DataInfo.attributes
- Defined in data-info/data-info.ts:26
set attributes(value: undefined | T): void
Parameters
- value: undefined | T
Returns void
Inherited from DataInfo.attributes
- Defined in data-info/data-info.ts:30

entries

get entries(): (F | DirectoryInfo<F, A, FA>)[]
Returns (F | DirectoryInfo<F, A, FA>)[]
- Defined in data-info/directory-info.ts:22
set entries(value: (F | DirectoryInfo<F, A, FA>)[]): void
Parameters
- value: (F | DirectoryInfo<F, A, FA>)[]
Returns void
- Defined in data-info/directory-info.ts:26

hash

get hash(): undefined | string
Returns undefined | string
Inherited from DataInfo.hash
- Defined in data-info/data-info.ts:36
set hash(value: undefined | string): void
Parameters
- value: undefined | string
Returns void
Inherited from DataInfo.hash
- Defined in data-info/data-info.ts:40

name

get name(): string
Returns string
Inherited from DataInfo.name
- Defined in data-info/data-info.ts:10

path

get path(): string
Returns string
- Defined in data-info/directory-info.ts:16

size

get size(): number
Returns number
Inherited from DataInfo.size
- Defined in data-info/data-info.ts:16
set size(value: number): void
Parameters
- value: number
Returns void
Inherited from DataInfo.size
- Defined in data-info/data-info.ts:20

type

get type(): string
Returns string
Inherited from DataInfo.type
- Defined in data-info/data-info.ts:4

Methods

addEntries

addEntries(entries: (F | DirectoryInfo<F, A, FA>)[]): void
Parameters
- entries: (F | DirectoryInfo<F, A, FA>)[]
Returns void
- Defined in data-info/directory-info.ts:166

clone

clone(): DirectoryInfo<F, A, FA>
Returns DirectoryInfo<F, A, FA>
Overrides DataInfo.clone
- Defined in data-info/directory-info.ts:172

`Static`extractFolderName

extractFolderName(path: string): undefined | string
Parameters
- path: string
Returns undefined | string
- Defined in data-info/directory-info.ts:47

`Static`fromFolderObject

fromFolderObject<
    F extends FileInfo<FA>,
    A extends object = any,
    FA extends object = any,
>(
    folder: null | FileSystemEntry,
): Promise<DirectoryInfo<F, A, FA>>
Type Parameters
- F extends FileInfo<FA>
- A extends object = any
- FA extends object = any
Parameters
- folder: null | FileSystemEntry
Returns Promise<DirectoryInfo<F, A, FA>>
- Defined in data-info/directory-info.ts:30