Skip to main content
The filesystem resource provides read-only access to the workspace’s virtual filesystem. Connected integrations and source views surface their data as files and directories you can list, read, and inspect.

list()

List entries in a directory.
Parameters Returns Promise<VirtualFile[]>

read()

Read file contents as a string.
For large files, use byte-range reads:
Parameters Returns Promise<string> — the file contents.

tree()

Get a recursive directory tree. Supports pagination for large directories.
Parameters Returns Promise<TreeListing>

stat()

Get metadata for a single file or directory without reading its contents.
Parameters Returns Promise<VirtualFile>