Interface Scope

Long-lived scope for launching and canceling related routines.

interface Scope {
    closed: Promise<void>;
    status: LaunchStatus;
    "[asyncDispose]"(): Promise<void>;
    cancel(): Promise<void>;
    run<Return>(
        ritual: RiteRoutine<Return>,
        options?: RunOptions,
    ): StatefulPromise<Return>;
}

Index

Properties

Methods

[asyncDispose] cancel run

Properties

`Readonly`closed

closed: Promise<void>

Promise that settles when this scope closes.

`Readonly`status

status: LaunchStatus

Current lifecycle state for this scope.

Methods

[asyncDispose]

"[asyncDispose]"(): Promise<void>
Cancels the scope when used with explicit resource management.

Returns Promise<void>
- Defined in work/shajara/shajara/packages/host/src/entries/create-scope.ts:49

cancel

cancel(): Promise<void>
Requests cancellation and waits for this scope to close. Expected cancellation resolves.

Returns Promise<void>
Throws
Shajara error when the scope closes with a non-cancellation failure.
- Defined in work/shajara/shajara/packages/host/src/entries/create-scope.ts:40

run

run<Return>(
ritual: RiteRoutine<Return>,
options?: RunOptions,
): StatefulPromise<Return>
Starts a routine owned by this scope. Non-cancellation failures from the launched routine propagate to this scope. Cancellation remains local to the launched routine.
Type Parameters
- Return
Parameters
- ritual: RiteRoutine<Return>
- Optionaloptions: RunOptions
Returns StatefulPromise<Return>
Stateful promise that resolves with the routine result or rejects with a shajara error.
- Defined in work/shajara/shajara/packages/host/src/entries/create-scope.ts:32