Files

Read, write, upload, and download runtime files.

FileManager declaration

class FileManager

This type is created by the SDK; do not construct it directly.

const manager = runtime.files;

Download a runtime file or directory locally.

FileManager.download(src: string, dst: string): Promise<void>

Name	Type	Default	Description
`src`	`string`	`Required`	Source path.
`dst`	`string`	`Required`	Destination path.

Read a file from the runtime as bytes.

FileManager.read(path: string, maxBytes?: number | null): Promise<Uint8Array<ArrayBufferLike>>

Name	Type	Default	Description
`path`	`string`	`Required`	Path inside the runtime.
`maxBytes?`	`number \| null`	`Optional`	Maximum number of bytes to return.

Read a UTF-8 text file from the runtime.

FileManager.readText(path: string, maxBytes?: number | null): Promise<string>

Name	Type	Default	Description
`path`	`string`	`Required`	Absolute path inside the runtime.
`maxBytes?`	`number \| null`	`Optional`	Optional maximum number of bytes to read.

const packageJson = await runtime.files.readText("/workspace/package.json");
console.log(JSON.parse(packageJson).name);

Upload a local file or directory to the runtime.

FileManager.upload(src: string, dst: string): Promise<void>

Name	Type	Default	Description
`src`	`string`	`Required`	Local source path.
`dst`	`string`	`Required`	Destination path inside the runtime.

await runtime.files.upload("./src", "/workspace/src");

Write bytes or text to a runtime file.

FileManager.write(
  path: string,
  content: string | Uint8Array<ArrayBufferLike>,
  options: { executable?: boolean } = {},
): Promise<void>

Name	Type	Default	Description
`path`	`string`	`Required`	Path inside the runtime.
`content`	`string \| Uint8Array<ArrayBufferLike>`	`Required`	Bytes or text to write.
`options`	`{ executable?: boolean }`	`{}`	Options that control the operation.