DirPlugin.

Classes

DirPlugableClass

Extends PlugableClass.

new DirPlugableClass(): DirPlugableClass

Returns DirPlugableClass. Inherited from PlugableClass.constructor.

PropertyType
exists(args: `/${string}`) => Promise<DataOrError<boolean>>
functionsFunctionRecord
read(args: `/${string}`) => Promise<DataOrError<string[]>>
size(args: `/${string}`) => Promise<DataOrError<number>>
write(args: `/${string}`) => Promise<DataOrError<`/${string}`>>

Methods

install(definition, …ids): void | Errored

ParameterTypeDescription
definitionstring | Function | StringTuple
…idsstring[]

Returns void | Errored. Inherited from PlugableClass.install.

toString(): string

Returns string. Inherited from PlugableClass.toString.

Variables

DirPlugin

const DirPlugin: DirPlugableClass

Functions

existsDirPlug

existsDirPlug(path): Promise<DataOrError<boolean>>

ParameterType
path`/${string}`

Returns Promise<DataOrError<boolean>>.

readDirPlug

readDirPlug(path): Promise<DataOrError<string[]>>

ParameterType
path`/${string}`

Returns Promise<DataOrError<string[]>>.

sizeDirPlug

sizeDirPlug(path): Promise<DataOrError<number>>

ParameterType
path`/${string}`

Returns Promise<DataOrError<number>>.

writeDirPlug

writeDirPlug(path): Promise<DataOrError<AbsolutePath>>

ParameterType
path`/${string}`

Returns Promise<DataOrError<AbsolutePath>>.