FilePlugin.

Classes

FilePlugableClass

Extends PlugableClass.

new FilePlugableClass(): FilePlugableClass

Returns FilePlugableClass. Inherited from PlugableClass.constructor.

PropertyType
copy(args: FileCopyArgs) => Promise<DataOrError<`/${string}`>>
exists(args: `/${string}`) => Promise<DataOrError<boolean>>
functionsFunctionRecord
json(args: `/${string}`) => Promise<DataOrError<object>>
modified(args: `/${string}`) => Promise<DataOrError<Date>>
read(args: `/${string}`) => Promise<DataOrError<string>>
remove(args: `/${string}`) => Promise<DataOrError<`/${string}`>>
size(args: `/${string}`) => Promise<DataOrError<number>>
write(args: FileWriteArgs) => 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

FilePlugin

const FilePlugin: FilePlugableClass

Functions

copyFilePlug

copyFilePlug(args): Promise<DataOrError<AbsolutePath>>

ParameterType
argsFileCopyArgs

Returns Promise<DataOrError<AbsolutePath>>.

existsFilePlug

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

ParameterType
path`/${string}`

Returns Promise<DataOrError<boolean>>.

modifiedFilePlug

modifiedFilePlug(filePath): Promise<DataOrError<Date>>

ParameterType
filePath`/${string}`

Returns Promise<DataOrError<Date>>.

readFilePlug

readFilePlug(path): Promise<DataOrError<string>>

ParameterType
path`/${string}`

Returns Promise<DataOrError<string>>.

sizeFilePlug

sizeFilePlug(filePath): Promise<DataOrError<number>>

ParameterType
filePath`/${string}`

Returns Promise<DataOrError<number>>.

writeFilePlug

writeFilePlug(args): Promise<DataOrError<AbsolutePath>>

ParameterType
argsFileWriteArgs

Returns Promise<DataOrError<AbsolutePath>>.