TypeScript process API

Start a private native S3 server, connect to an existing endpoint, or run a scoped session. Import from @chester-hill-solutions/stow-s3.

Defaults and limits

Behavior

• withStow closes its session after the callback.
• openStow requires an explicit close.
• Sessions strip inherited cloud settings.
• Stow.start preserves the child environment unless isolatedEnvironment is enabled.
• A session removes only its own temporary directory; a supplied dataDir remains.
• Closing a connection destroys its SDK client without stopping the remote server.

Errors

• Startup can fail on cancellation, timeout, missing binaries or invalid readiness.
• StowProtocolError exposes code; StowOwnershipError rejects unsafe directory resets.
• SDK object requests use S3 errors.
• Workspace helpers reject failed commands.
• A callback failure remains observable if cleanup also fails.

Example

import { withStow } from "@chester-hill-solutions/stow-s3";
import { PutObjectCommand } from "@aws-sdk/client-s3";

await withStow(async ({ s3, bucket }) => {
  await s3.send(new PutObjectCommand({ Bucket: bucket, Key: "note", Body: "hello" }));
});

Symbols

AwsSdkV3ConfigOptions · checkpointWorkspace · collectWorkspaces · ConnectOptions · default · DEFAULT_SESSION_MAX_BYTES · DEFAULT_SESSION_MAX_OBJECTS · destroyWorkspace · diffWorkspaces · EMBEDDED_PROTOCOL_VERSION · EmbeddedBucket · EmbeddedCapabilities · EmbeddedHost · EmbeddedListOptions · EmbeddedObject · EmbeddedObjectPage · EmbeddedPutOptions · EmbeddedStow · EmbeddedStowError · EmbeddedStowOptions · EmbeddedUsage · EphemeralStowOptions · exportWorkspaceCheckpoint · handoffWorkspace · importWorkspaceCheckpoint · loadNodeWasmHost · NodeWasmHost · ObjectSnapshot · openStow · parseReadyLine · parseReadyMessage · prepareWorkspace · pruneWorkspaces · PutFixtureOptions · READY_PROTOCOL_VERSION · resetOwnedData · resolveStowBinary · restoreWorkspaceCheckpoint · resumeWorkspace · ResumeWorkspaceOptions · runWorkspaceCommand · ServedWorkspace · serveWorkspace · ServeWorkspaceOptions · StartOptions · Stow · STOW_OWNER_MARKER · stowBinaryAvailable · StowBinaryNotFoundError · StowConnection · StowInstance · StowMode · StowOwnershipError · StowProtocolError · StowReady · StowReadyCapabilities · StowSession · StowSessionCapabilities · UpstreamConfig · upstreamFromEnv · withStow · WorkspaceArchiveOptions · WorkspaceCheckpointOptions · WorkspaceJSON

AwsSdkV3ConfigOptions

type AwsSdkV3ConfigOptions = (AwsSdkV3ConfigBase & {
    accessKeyId: string;
    secretAccessKey: string;
    sessionToken?: string;
    provider?: AwsCredentialIdentityProvider;
}) | (AwsSdkV3ConfigBase & {
    provider: AwsCredentialIdentityProvider;
    accessKeyId?: string;
    secretAccessKey?: string;
    sessionToken?: string;
});

checkpointWorkspace

Capture an immutable checkpoint of paused writers.

checkpointWorkspace(options: WorkspaceCheckpointOptions): Promise<Readonly<Record<string, unknown>>>

Returns: Promise<Readonly<Record<string, unknown>>>.

collectWorkspaces

Collect expired workspaces that are unused and eligible for deletion.

collectWorkspaces(registryDir?: string | undefined): Promise<Readonly<Record<string, unknown>>>

Returns: Promise<Readonly<Record<string, unknown>>>.

ConnectOptions

type ConnectOptions = AwsSdkV3ConfigOptions;

default

The same Stow helper object as the named export.

const Stow: { start(options?: StartOptions | undefined): Promise<StowInstance>; connect(options: AwsSdkV3ConfigOptions): StowConnection; awsSdkV3Config(options: StowInstance | AwsSdkV3ConfigOptions): S3ClientConfig; upstream: { fromEnv(): UpstreamConfig | null; }; };

default.start

Start a native server and create the requested buckets before returning its handle.

start(options?: StartOptions | undefined): Promise<StowInstance>

Returns: Promise<StowInstance>.

default.connect

Create an owned SDK client for an existing endpoint; disconnect it when finished.

connect(options: AwsSdkV3ConfigOptions): StowConnection

Returns: StowConnection.

default.awsSdkV3Config

Return AWS SDK connection settings with local credentials and path-style addressing by default.

awsSdkV3Config(options: StowInstance | AwsSdkV3ConfigOptions): S3ClientConfig

Returns: S3ClientConfig.

DEFAULT_SESSION_MAX_BYTES

Default session storage limit: 16 MiB.

const DEFAULT_SESSION_MAX_BYTES: number;

DEFAULT_SESSION_MAX_OBJECTS

Default session object count: 1,000.

const DEFAULT_SESSION_MAX_OBJECTS: 1000;

destroyWorkspace

Explicitly destroy a registered, eligible workspace.

destroyWorkspace(id: string, registryDir?: string | undefined): Promise<Readonly<Record<string, unknown>>>

Returns: Promise<Readonly<Record<string, unknown>>>.

diffWorkspaces

Compare two checkpoints and return changed paths.

diffWorkspaces(from: string, to: string, registryDir?: string | undefined, team?: string | undefined): Promise<Readonly<Record<string, unknown>>>

Returns: Promise<Readonly<Record<string, unknown>>>.

EMBEDDED_PROTOCOL_VERSION

const EMBEDDED_PROTOCOL_VERSION: 1;

EmbeddedBucket

interface EmbeddedBucket {
  name: string;
  creationDate?: string | undefined;
}

EmbeddedCapabilities

interface EmbeddedCapabilities {
  backend: "memory" | "indexeddb" | "host";
  maxBytes: number;
  maxObjects: number;
  persistent: boolean;
  multipart: boolean;
  upstream: boolean;
  conditionalWrites?: boolean | undefined;
  hostMaintenance?: boolean | undefined;
}

EmbeddedHost

interface EmbeddedHost {
  call(request: string): string;
  callBinary(metadata: string, data?: Uint8Array<ArrayBufferLike> | undefined): EmbeddedBinaryResponse;
}

EmbeddedHost.call

call(request: string): string

Returns: string.

EmbeddedHost.callBinary

Binary calls preserve caller ownership; returned bytes belong to the caller.

callBinary(metadata: string, data?: Uint8Array<ArrayBufferLike> | undefined): EmbeddedBinaryResponse

Returns: EmbeddedBinaryResponse.

EmbeddedListOptions

interface EmbeddedListOptions {
  prefix?: string | undefined;
  cursor?: string | undefined;
  limit?: number | undefined;
}

EmbeddedObject

interface EmbeddedObject {
  bucket: string;
  key: string;
  data?: Uint8Array<ArrayBufferLike> | undefined;
  size: number;
  etag: string;
  contentType?: string | undefined;
  metadata?: Record<string, string> | undefined;
  lastModified?: string | undefined;
}

EmbeddedObjectPage

interface EmbeddedObjectPage {
  objects: EmbeddedObject[];
  truncated: boolean;
  nextCursor?: string | undefined;
}

EmbeddedPutOptions

interface EmbeddedPutOptions {
  contentType?: string | undefined;
  metadata?: Record<string, string> | undefined;
  ifMatch?: string | undefined;
  ifNoneMatch?: string | undefined;
}

EmbeddedStow

class EmbeddedStow {
  static open(host: EmbeddedHost, options?: EmbeddedStowOptions): EmbeddedStow;
  readonly handle: number;
  capabilities(): EmbeddedCapabilities;
  usage(): EmbeddedUsage;
  createBucket(bucket: string): void;
  deleteBucket(bucket: string): void;
  listBuckets(): EmbeddedBucket[];
  putObject(bucket: string, key: string, data: Uint8Array<ArrayBufferLike>, options?: EmbeddedPutOptions): EmbeddedObject;
  getObject(bucket: string, key: string): EmbeddedObject;
  headObject(bucket: string, key: string): EmbeddedObject;
  listObjects(bucket: string, options?: EmbeddedListOptions): EmbeddedObjectPage;
  deleteObject(bucket: string, key: string): void;
  copyObject(sourceBucket: string, sourceKey: string, destinationBucket: string, destinationKey: string): EmbeddedObject;
  reset(): void;
  close(): void;
}

EmbeddedStow.open

Open a handle. Retain it until operations finish, then close it.

open(host: EmbeddedHost, options?: EmbeddedStowOptions): EmbeddedStow

Returns: EmbeddedStow.

EmbeddedStow.capabilities

Return the operations and limits supported by this handle.

capabilities(): EmbeddedCapabilities

Returns: EmbeddedCapabilities.

EmbeddedStow.usage

Return current storage accounting.

usage(): EmbeddedUsage

Returns: EmbeddedUsage.

EmbeddedStow.createBucket

Create the named bucket before storing objects.

createBucket(bucket: string): void

Returns: void.

EmbeddedStow.deleteBucket

Remove an empty bucket; a nonempty bucket is refused.

deleteBucket(bucket: string): void

Returns: void.

EmbeddedStow.listBuckets

Return the buckets visible to the handle.

listBuckets(): EmbeddedBucket[]

Returns: EmbeddedBucket[].

EmbeddedStow.putObject

Store complete bytes and metadata, subject to write conditions and quotas.

putObject(bucket: string, key: string, data: Uint8Array<ArrayBufferLike>, options?: EmbeddedPutOptions): EmbeddedObject

Returns: EmbeddedObject.

EmbeddedStow.getObject

Return complete object bytes and metadata.

getObject(bucket: string, key: string): EmbeddedObject

Returns: EmbeddedObject.

EmbeddedStow.headObject

Return object metadata without reading the body into the result.

headObject(bucket: string, key: string): EmbeddedObject

Returns: EmbeddedObject.

EmbeddedStow.listObjects

Return one page. Pass nextCursor to continue when truncated is true.

listObjects(bucket: string, options?: EmbeddedListOptions): EmbeddedObjectPage

Returns: EmbeddedObjectPage.

EmbeddedStow.deleteObject

Delete the selected object; deleting a missing object is idempotent.

deleteObject(bucket: string, key: string): void

Returns: void.

EmbeddedStow.copyObject

Copy source bytes and metadata to the destination object.

copyObject(sourceBucket: string, sourceKey: string, destinationBucket: string, destinationKey: string): EmbeddedObject

Returns: EmbeddedObject.

EmbeddedStow.reset

Clear storage state where the backend supports reset.

reset(): void

Returns: void.

EmbeddedStow.close

Release this handle. Do not submit new operations after closing it.

close(): void

Returns: void.

EmbeddedStowError

class EmbeddedStowError  extends Error {
  readonly code: string;
  constructor(code: string, message: string);
}

EmbeddedStowError.constructor

function Object() { [native code] }

constructor(code: string, message: string)

Returns: EmbeddedStowError.

EmbeddedStowOptions

interface EmbeddedStowOptions {
  maxBytes?: number | undefined;
  maxObjects?: number | undefined;
}

EmbeddedUsage

interface EmbeddedUsage {
  bytes: number;
  objects: number;
}

EphemeralStowOptions

interface EphemeralStowOptions {
  readonly maxRequestBytes?: number | undefined;
  maxConcurrentRequests?: number | undefined;
  readonly maxBytes?: number | undefined;
  readonly maxObjects?: number | undefined;
  readonly bucket?: string | undefined;
  readonly timeoutMs?: number | undefined;
  readonly signal?: AbortSignal | undefined;
  readonly dataDir?: string | undefined;
}

exportWorkspaceCheckpoint

Write a portable checkpoint archive to the selected file.

exportWorkspaceCheckpoint(checkpointId: string, output: string, options?: WorkspaceArchiveOptions): Promise<Readonly<Record<string, unknown>>>

Returns: Promise<Readonly<Record<string, unknown>>>.

handoffWorkspace

Create a handoff reference, optionally with a portable archive.

handoffWorkspace(id: string, options?: { readonly registryDir?: string | undefined; readonly team?: string | undefined; readonly checkpointId?: string | undefined; readonly archive?: string | undefined; readonly output?: string | undefined; }): Promise<Readonly<Record<string, unknown>>>

Returns: Promise<Readonly<Record<string, unknown>>>.

importWorkspaceCheckpoint

Validate and import a portable checkpoint archive.

importWorkspaceCheckpoint(archive: string, options?: WorkspaceArchiveOptions): Promise<Readonly<Record<string, unknown>>>

Returns: Promise<Readonly<Record<string, unknown>>>.

loadNodeWasmHost

loadNodeWasmHost(): Promise<NodeWasmHost>

Returns: Promise<NodeWasmHost>.

NodeWasmHost

interface NodeWasmHost  extends EmbeddedHost {
  callBinaryAsync(metadata: string, data?: Uint8Array<ArrayBufferLike> | undefined): Promise<EmbeddedBinaryResponse>;
  openHost(metadata: string, store: HostObjectStoreBridge): Promise<EmbeddedBinaryResponse>;
  close(): Promise<void>;
}

NodeWasmHost.callBinaryAsync

callBinaryAsync(metadata: string, data?: Uint8Array<ArrayBufferLike> | undefined): Promise<EmbeddedBinaryResponse>

Returns: Promise<EmbeddedBinaryResponse>.

NodeWasmHost.openHost

openHost(metadata: string, store: HostObjectStoreBridge): Promise<EmbeddedBinaryResponse>

Returns: Promise<EmbeddedBinaryResponse>.

NodeWasmHost.close

Release this handle. Do not submit new operations after closing it.

close(): Promise<void>

Returns: Promise<void>.

ObjectSnapshot

interface ObjectSnapshot {
  key: string;
  size: number;
  etag?: string | undefined;
  lastModified?: Date | undefined;
}

openStow

Start a private S3 session and return its owned handle. Call close when finished.

openStow(options?: EphemeralStowOptions): Promise<StowSession>

Returns: Promise<StowSession>.

parseReadyLine

Parse the pre-protocol single-line readiness announcement.

parseReadyLine(line: string): ReadyLine | null

Returns: ReadyLine | null.

parseReadyMessage

Parse the single readiness object.

parseReadyMessage(line: string): StowReady

Returns: StowReady.

prepareWorkspace

Create a workspace from a task manifest and return its launch descriptor.

prepareWorkspace(manifestPath: string): Promise<Readonly<Record<string, unknown>>>

Returns: Promise<Readonly<Record<string, unknown>>>.

pruneWorkspaces

Remove registry records for missing directories; preserve existing directories.

pruneWorkspaces(options?: { readonly registryDir?: string | undefined; readonly team?: string | undefined; readonly includeAdopted?: boolean | undefined; }): Promise<Readonly<Record<string, unknown>>>

Returns: Promise<Readonly<Record<string, unknown>>>.

PutFixtureOptions

interface PutFixtureOptions {
  contentType?: string | undefined;
  metadata?: Record<string, string> | undefined;
}

READY_PROTOCOL_VERSION

const READY_PROTOCOL_VERSION: 1;

resetOwnedData

Delete a stow data directory that stow created, and nothing else.

resetOwnedData(dataDir: string): Promise<void>

Returns: Promise<void>.

resolveStowBinary

resolveStowBinary(): string

Returns: string.

restoreWorkspaceCheckpoint

Restore a checkpoint into a new workspace directory.

restoreWorkspaceCheckpoint(checkpointId: string, root: string, registryDir?: string | undefined): Promise<Readonly<Record<string, unknown>>>

Returns: Promise<Readonly<Record<string, unknown>>>.

resumeWorkspace

Open the workspace selected by ID or a same-machine handoff.

resumeWorkspace(options: ResumeWorkspaceOptions): Promise<Readonly<Record<string, unknown>>>

Returns: Promise<Readonly<Record<string, unknown>>>.

ResumeWorkspaceOptions

interface ResumeWorkspaceOptions {
  readonly id?: string | undefined;
  readonly handoffPath?: string | undefined;
  readonly registryDir?: string | undefined;
}

runWorkspaceCommand

Run the native workspace command without a shell and decode its JSON object.

runWorkspaceCommand(args: readonly string[]): Promise<Readonly<Record<string, unknown>>>

Returns: Promise<Readonly<Record<string, unknown>>>.

ServedWorkspace

interface ServedWorkspace {
  readonly ready: Readonly<Record<string, unknown>>;
  close(): Promise<void>;
}

ServedWorkspace.close

Release this handle. Do not submit new operations after closing it.

close(): Promise<void>

Returns: Promise<void>.

serveWorkspace

Own a workspace S3 server until the returned handle closes; preserve workspace data.

serveWorkspace(options: ServeWorkspaceOptions): Promise<ServedWorkspace>

Returns: Promise<ServedWorkspace>.

ServeWorkspaceOptions

interface ServeWorkspaceOptions {
  readonly maxRequestBytes?: number | undefined;
  maxConcurrentRequests?: number | undefined;
  readonly id: string;
  readonly registryDir?: string | undefined;
  readonly team?: string | undefined;
  readonly maxBytes?: number | undefined;
  readonly maxObjects?: number | undefined;
  readonly timeoutMs?: number | undefined;
  readonly signal?: AbortSignal | undefined;
}

StartOptions

interface StartOptions {
  dataDir?: string | undefined;
  backend?: "memory" | "filesystem" | undefined;
  buckets?: string[] | undefined;
  port?: number | undefined;
  host?: string | undefined;
  timeoutMs?: number | undefined;
  signal?: AbortSignal | undefined;
  region?: string | undefined;
  baseHost?: string | undefined;
  allowPublicAdmin?: boolean | undefined;
  resetOwnedData?: boolean | undefined;
  cleanSlate?: boolean | undefined;
  accessKey?: string | undefined;
  secretKey?: string | undefined;
  mode?: StowMode | "auto" | undefined;
  cacheDir?: string | undefined;
  cacheMaxBytes?: number | undefined;
  cacheMaxObjects?: number | undefined;
  cacheTtlSeconds?: number | undefined;
  allowLiveWrites?: boolean | undefined;
  allowInsecureUpstream?: boolean | undefined;
  maxRequestBytes?: number | undefined;
  maxConcurrentRequests?: number | undefined;
  maxBytes?: number | undefined;
  maxObjects?: number | undefined;
  isolatedEnvironment?: boolean | undefined;
  parentPid?: number | undefined;
}

Stow

Server startup, endpoint connection and AWS SDK configuration helpers.

const Stow: { start(options?: StartOptions | undefined): Promise<StowInstance>; connect(options: AwsSdkV3ConfigOptions): StowConnection; awsSdkV3Config(options: StowInstance | AwsSdkV3ConfigOptions): S3ClientConfig; upstream: { fromEnv(): UpstreamConfig | null; }; };

Stow.start

Start a native server and create the requested buckets before returning its handle.

start(options?: StartOptions | undefined): Promise<StowInstance>

Returns: Promise<StowInstance>.

Stow.connect

Create an owned SDK client for an existing endpoint; disconnect it when finished.

connect(options: AwsSdkV3ConfigOptions): StowConnection

Returns: StowConnection.

Stow.awsSdkV3Config

Return AWS SDK connection settings with local credentials and path-style addressing by default.

awsSdkV3Config(options: StowInstance | AwsSdkV3ConfigOptions): S3ClientConfig

Returns: S3ClientConfig.

STOW_OWNER_MARKER

The file a stow server writes into a data directory it has initialized.

const STOW_OWNER_MARKER: ".stow-owner";

stowBinaryAvailable

stowBinaryAvailable(): boolean

Returns: boolean.

StowBinaryNotFoundError

StowBinaryNotFoundError reports that no runnable server binary was found.

class StowBinaryNotFoundError  extends Error {
  readonly code: "binary_not_found";
  constructor(resolved: string);
}

StowBinaryNotFoundError.constructor

function Object() { [native code] }

constructor(resolved: string)

Returns: StowBinaryNotFoundError.

StowConnection

interface StowConnection {
  endpoint: string;
  accessKeyId?: string | undefined;
  secretAccessKey?: string | undefined;
  sessionToken?: string | undefined;
  provider?: AwsCredentialIdentityProvider | undefined;
  region: string;
  client: S3Client;
  awsSdkV3Config(): S3ClientConfig;
  disconnect(): void;
}

StowConnection.awsSdkV3Config

Return AWS SDK connection settings with local credentials and path-style addressing by default.

awsSdkV3Config(): S3ClientConfig

Returns: S3ClientConfig.

StowConnection.disconnect

disconnect(): void

Returns: void.

StowInstance

interface StowInstance {
  endpoint: string;
  accessKeyId: string;
  secretAccessKey: string;
  region: string;
  mode: StowMode;
  dataDir: string;
  stop(): Promise<void>;
  awsSdkV3Config(): S3ClientConfig;
  createBucket(name: string): Promise<void>;
  emptyBucket(name: string): Promise<void>;
  putFixture(bucket: string, key: string, body: any, options?: PutFixtureOptions | undefined): Promise<void>;
  snapshotObjects(bucket: string, prefix?: string | undefined): Promise<ObjectSnapshot[]>;
}

StowInstance.stop

stop(): Promise<void>

Returns: Promise<void>.

StowInstance.awsSdkV3Config

Return AWS SDK connection settings with local credentials and path-style addressing by default.

awsSdkV3Config(): S3ClientConfig

Returns: S3ClientConfig.

StowInstance.createBucket

Create the named bucket before storing objects.

createBucket(name: string): Promise<void>

Returns: Promise<void>.

StowInstance.emptyBucket

emptyBucket(name: string): Promise<void>

Returns: Promise<void>.

StowInstance.putFixture

putFixture(bucket: string, key: string, body: any, options?: PutFixtureOptions | undefined): Promise<void>

Returns: Promise<void>.

StowInstance.snapshotObjects

snapshotObjects(bucket: string, prefix?: string | undefined): Promise<ObjectSnapshot[]>

Returns: Promise<ObjectSnapshot[]>.

StowMode

type StowMode = "local" | "run-through";

StowOwnershipError

A directory stow did not create is never deleted on a caller's behalf.

class StowOwnershipError  extends Error {
  readonly code: "ownership";
  constructor(dataDir: string, reason: string);
}

StowOwnershipError.constructor

function Object() { [native code] }

constructor(dataDir: string, reason: string)

Returns: StowOwnershipError.

StowProtocolError

class StowProtocolError  extends Error {
  readonly code: StowErrorCode;
  constructor(code: StowErrorCode, message: string);
}

StowProtocolError.constructor

function Object() { [native code] }

constructor(code: StowErrorCode, message: string)

Returns: StowProtocolError.

StowReady

interface StowReady {
  protocolVersion: number;
  binaryVersion: string;
  endpoint: string;
  region: string;
  accessKeyId: string;
  secretAccessKey: string;
  mode: string;
  backend: string;
  capabilities: StowReadyCapabilities;
}

StowReadyCapabilities

interface StowReadyCapabilities {
  persistent: boolean;
  multipart: boolean;
  upstream: boolean;
  conditionalWrites: boolean;
  presignedUrls: boolean;
  maxBytes: number;
  maxObjects: number;
  maxRequestBytes: number;
  maxConcurrentRequests?: number | undefined;
}

StowSession

interface StowSession {
  readonly bucket: string;
  readonly endpoint: string;
  readonly dataDir: string;
  readonly s3: S3Client;
  awsSdkV3Config(): S3ClientConfig;
  capabilities(): StowSessionCapabilities;
  handoff(): Record<string, string>;
  close(): Promise<void>;
}

StowSession.awsSdkV3Config

Return AWS SDK connection settings with local credentials and path-style addressing by default.

awsSdkV3Config(): S3ClientConfig

Returns: S3ClientConfig.

StowSession.capabilities

Return the operations and limits supported by this handle.

capabilities(): StowSessionCapabilities

Returns: StowSessionCapabilities.

StowSession.handoff

A fresh environment mapping for a child process that needs to reach this session.

handoff(): Record<string, string>

Returns: Record<string, string>.

StowSession.close

Release this handle. Do not submit new operations after closing it.

close(): Promise<void>

Returns: Promise<void>.

StowSessionCapabilities

interface StowSessionCapabilities {
  backend: string;
  persistent: boolean;
  multipart: boolean;
  upstream: boolean;
  maxBytes: number;
  maxObjects: number;
  maxRequestBytes: number;
  maxConcurrentRequests: number;
  protocolVersion: number;
  binaryVersion: string;
}

UpstreamConfig

interface UpstreamConfig {
  endpoint: string;
  accessKey: string;
  secretKey: string;
  sessionToken?: string | undefined;
  region?: string | undefined;
  bucket?: string | undefined;
}

upstreamFromEnv

Resolve upstream credentials from environment variables.

upstreamFromEnv(): UpstreamConfig | null

Returns: UpstreamConfig | null.

withStow

Run the callback in a private session and always close it.

withStow<T>(use: (session: StowSession) => T | Promise<T>, options?: EphemeralStowOptions): Promise<T>

Returns: Promise<T>.

WorkspaceArchiveOptions

interface WorkspaceArchiveOptions {
  readonly registryDir?: string | undefined;
  readonly team?: string | undefined;
  readonly maxBytes?: number | undefined;
  readonly maxFiles?: number | undefined;
  readonly includeSensitive?: boolean | undefined;
}

WorkspaceCheckpointOptions

interface WorkspaceCheckpointOptions {
  readonly id: string;
  readonly registryDir?: string | undefined;
  readonly team?: string | undefined;
  readonly parent?: string | undefined;
  readonly maxBytes?: number | undefined;
  readonly maxFiles?: number | undefined;
  readonly includeSensitive?: boolean | undefined;
}

WorkspaceJSON

type WorkspaceJSON = Readonly<Record<string, unknown>>;