Generated TypeScript API index

Generated from the package declaration files. Run bun run --cwd apps/docs typescript:generate after building packages. The TypeScript SDK reference explains behavior and recovery guarantees.

SDK

Import from beachside.

Export	Kind
ADAPTER_CONTRACT_VERSION	re-export
AdapterCapabilities	type
AdapterConnectOptions	type
AdapterDirectClient	re-export
AdapterImage	re-export
AdapterOperation	re-export
AdapterRecoveryReference	type
AdapterSandbox	re-export
AdapterSnapshot	re-export
AdapterVolume	re-export
AdvancedIdentity	type
AdvancedObservation	type
AdvancedOperationKind	type
AdvancedOperationResult	type
ArtifactDeletionResult	re-export
assertResourceIdentity	re-export
assertResourceScope	re-export
Beachside	value
BeachsideClient	type
BeachsideError	re-export
Capabilities	type
CloseOptions	type
ConnectOptions	type
CreateInput	type
CreatePlan	type
createProcessTail	re-export
Deadline	type
diagnosticContext	re-export
DiagnosticContext	type
DirectBeachsideClient	type
DirectCapabilities	type
DirectConnectOptions	type
DirectoryResult	type
DirectSandboxHandle	type
ExecInput	type
ExecOptions	type
ExecOutput	type
Fact	type
FileEntry	type
FileReadOptions	type
FileStat	type
FileStreamOptions	type
FileStreamWriteOptions	type
FilesystemError	re-export
FileWriteOptions	type
Image	re-export
ImageBuildResult	type
ImageHandle	type
ImageInfo	re-export
ImageInput	type
MountCapabilities	type
MountSpec	re-export
NetworkPolicy	type
NoExitCodeError	re-export
NonzeroExitError	re-export
ObservabilityOptions	type
OperationHandle	type
OperationOutcome	type
OutcomeUnknownError	re-export
OutputPreview	type
outputText	re-export
PreparedAdapterAttempt	re-export
PreparedImage	type
Preserve	re-export
Preview	type
ProcessChunk	type
ProcessExit	type
ProcessFailure	type
ProcessHandle	type
ProcessLine	type
ProcessLineOptions	type
ProcessOutput	type
ProcessOutputBytes	type
ProcessOutputFormat	type
ProcessReference	type
ProcessSignal	type
ProcessStatus	type
ProcessTail	type
ProcessTailOptions	type
ProcessTermination	type
ReadOptions	type
readProcessLines	re-export
ReadTextLinesOptions	type
RecoveredOperation	type
RecoveryReference	type
RenewRequest	type
RenewResult	type
ResourceKind	re-export
ResourceMinimums	type
ResourceReference	re-export
RestoreCapabilities	type
RestoreInput	type
RestoreRequest	re-export
ResumeResult	type
SandboxCleanupError	re-export
SandboxHandle	type
SandboxInfo	type
SandboxList	type
SandboxListEntry	type
SandboxListInput	type
SandboxReference	type
SandboxResources	type
SandboxScopeCallbackOutcome	type
SandboxScopeOptions	type
SandboxState	type
SnapshotHandle	type
SnapshotInfo	re-export
SnapshotPlan	type
SnapshotProfile	type
SnapshotRequest	re-export
SnapshotRequirements	re-export
SnapshotResult	type
StartProcessInput	type
StartTerminalInput	type
Support	type
SuspendResult	type
TerminalDimensions	type
TerminalHandle	type
TransferPolicy	type
UnsupportedFeatureError	re-export
validateResourceReference	re-export
VolumeCapabilities	type
VolumeCreateInput	re-export
VolumeHandle	type
VolumeInfo	re-export
WaitAbortedError	re-export
WaitOptions	type
WalkFileEntry	type
WalkFilesOptions	type

Daytona adapter

Import from @beachside/daytona.

Export	Kind
boundedBytes	function
createDaytonaAdapter	re-export
daytona	re-export
daytonaAdapter	re-export
DaytonaDriver	class
DaytonaEndpointPair	type
DaytonaInput	type
daytonaProvider	function
daytonaRegistration	function

E2B adapter

Import from @beachside/e2b.

Export	Kind
createE2BAdapter	function
e2b	re-export
E2B_ENDPOINT	re-export
e2bAdapter	value
E2BTransport	type
MAX_BYTES	re-export

Experimental Modal adapter

Import from @beachside/modal.

Export	Kind
createModalAdapter	re-export
MODAL_ENDPOINT	re-export
modalAdapter	re-export
ModalTransport	type

Adapter authoring

Import from @beachside/adapter.

Export	Kind
AdapterCheckpointError	class
AdapterConnection	type
AdapterDefinition	type
AdapterError	re-export
AdapterErrorCode	type
AdapterFilesystemError	re-export
AdapterSession	type
AttemptContext	type
bindAdapter	re-export
BoundAdapter	type
Command	type
connectAdapter	function
continueOperation	re-export
createAttemptContext	function
CreateInput	type
createObserveContext	function
CreateSandboxInput	re-export
CreateValue	type
defineAdapter	function
DestroyValue	type
DirectoryResult	type
ExecCommand	re-export
ExecInput	type
ExecRequest	re-export
ExecValue	type
FileEntry	type
FileMutationInput	type
FileMutationIntent	re-export
FileMutationValue	re-export
FileStat	type
FileTransferContext	type
FileTransferInput	type
FileWriteInput	type
FileWriteValue	type
Guarantees	type
HostContext	type
Image	type
ImageBuildInput	type
ImageBuildValue	type
ImageInput	type
isOutcome	function
Json	type
MAX_DIRECTORY_ENTRIES	re-export
MAX_DIRECTORY_NAME_BYTES	re-export
MAX_EXEC_STDIN_BYTES	re-export
Mutation	type
NativeProcess	interface
NativeProcessExit	type
NativeProcessStatus	type
ObserveContext	type
observeOperation	re-export
OciImage	type
OperationInput	type
OperationKind	type
OperationOutcome	re-export
operationParts	function
OperationParts	type
outcomeKind	function
Pending	type
PolicyAdapterDefinition	type
PreparedOperation	type
prepareOperation	re-export
ProcessObservationFailure	type
ProcessOutput	type
ProcessOutputBytes	type
ProcessOutputFormat	type
ProcessReopenInput	type
ProcessSignal	type
ProcessStartContext	type
ProcessStartInput	type
ReadContext	type
RecoveryAttempt	type
RecoveryResource	type
Rejected	type
RetainedArtifact	type
RuntimeResult	type
RuntimeSession	type
SafeError	re-export
Sandbox	type
Scope	type
submitOperation	re-export
TerminalDimensions	type
Unknown	type
validateAdapterConfiguration	function

Adapter test kit

Import from @beachside/adapter/testing.

Export	Kind
adapterSuite	function
AdapterSuiteFixture	type
AdapterSuiteReport	type
filesystemSuite	function
snapshotSuite	function
SnapshotSuiteClient	type