spawn-ts API reference - v0.6.0
    Preparing search index...

    Interface Provider

    interface Provider {
        isReal: boolean;
        label: string;
        get(nameOrId: string): Promise<ManagedInstance | null>;
        hibernate(instanceId: string): Promise<void>;
        launch(spec: LaunchSpec, launchTimeMs: number): Promise<ManagedInstance>;
        list(includeTerminated?: boolean): Promise<ManagedInstance[]>;
        setTags(instanceId: string, tags: Record<string, string>): Promise<void>;
        start(instanceId: string): Promise<void>;
        stop(instanceId: string, reason: string): Promise<void>;
        terminate(instanceId: string, reason: string): Promise<void>;
    }

    Implemented by

    Index
    isReal: boolean

    Whether this provider touches real, billable resources. Drives UI warnings.

    label: string

    Human label for the active backend, shown in the UI ("mock", "aws:us-east-1", "substrate").

    • Hibernate (RAM saved to disk).

      Parameters

      • instanceId: string

      Returns Promise<void>

    • List all spawn-managed instances (spawn:managed=true), excluding terminated by default.

      Parameters

      • OptionalincludeTerminated: boolean

      Returns Promise<ManagedInstance[]>

    • Overwrite/merge tags on an instance. Used by extend to push out spawn:ttl-deadline, and by the sim to update spawn:compute-seconds.

      Parameters

      • instanceId: string
      • tags: Record<string, string>

      Returns Promise<void>

    • Start a stopped/hibernated instance.

      Parameters

      • instanceId: string

      Returns Promise<void>

    • Stop (billing pauses, EBS persists).

      Parameters

      • instanceId: string
      • reason: string

      Returns Promise<void>

    • Terminate (permanent).

      Parameters

      • instanceId: string
      • reason: string

      Returns Promise<void>