Skip to main content

FileReader

@forge/monorepo

@forge/monorepo / backend/src / FileReader

Type Alias: FileReader

FileReader = object

Defined in: backend/src/toolkit/files.ts:131

Methods​

list()​

list(path?): FileFailure | FileList

Defined in: backend/src/toolkit/files.ts:133

Parameters​

path?​

string

Returns​

FileFailure | FileList

read()​

read(path): FileFailure | FileRead

Defined in: backend/src/toolkit/files.ts:132

Parameters​

path​

string

Returns​

FileFailure | FileRead

search(input): FileFailure | FileSearch

Defined in: backend/src/toolkit/files.ts:134

Parameters​

input​
namePattern?​

string

path?​

string

query​

string

Returns​

FileFailure | FileSearch

write()​

write(input): FileFailure | FileWrite

Defined in: backend/src/toolkit/files.ts:135

Parameters​

input​
content​

string

path​

string

Returns​

FileFailure | FileWrite