Files
LlamaIndexTS/apps/docs/docs/api/interfaces/GenericFileSystem.md
T
Yi Ding 7699f5432d set typedoc revision to main
In theory this will stop the API docs thrashing on every build.

Of course, there is a drawback in that if main changes but we haven't
released a new version of the docs yet the links will go out of date.

So longer term we might want to investigate some kind of variable where
we can continue to have up to date revs but keep the rev in a single
variable somewhere:

https://github.com/facebook/docusaurus/issues/395

In the meantime much smaller commits will be a relief
2023-07-25 23:06:44 -07:00

1.8 KiB

id, title, sidebar_label, sidebar_position, custom_edit_url
id title sidebar_label sidebar_position custom_edit_url
GenericFileSystem Interface: GenericFileSystem GenericFileSystem 0 null

A filesystem interface that is meant to be compatible with the 'fs' module from Node.js. Allows for the use of similar inteface implementation on browsers.

Implemented by

Methods

access

access(path): Promise<void>

Parameters

Name Type
path string

Returns

Promise<void>

Defined in

storage/FileSystem.ts:12


mkdir

mkdir(path, options?): Promise<void>

Parameters

Name Type
path string
options? any

Returns

Promise<void>

Defined in

storage/FileSystem.ts:13


readFile

readFile(path, options?): Promise<string>

Parameters

Name Type
path string
options? any

Returns

Promise<string>

Defined in

storage/FileSystem.ts:11


writeFile

writeFile(path, content, options?): Promise<void>

Parameters

Name Type
path string
content string
options? any

Returns

Promise<void>

Defined in

storage/FileSystem.ts:10