Reference

Reference documentation for the CBFS public API

Use this section as the lookup index for CBFS's public API. The usage guides explain common workflows; these pages describe public methods, arguments, return values, and provider-specific boundaries.

Disk Service

Register, resolve, inspect, and shut down disks.

Disk API

Explore the common IDisk contract shared by providers.

File Object

Use the fluent wrapper returned by disk.file().

Provider capabilities

Compare supported operations across Local, RAM, and S3.

Configuration

Configure disks, provider properties, and environment variables.

Integration and lifecycle

Use injection, helpers, module disks, and interception points.

Errors

Handle missing paths, overwrite failures, and provider errors.