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

    Interface ShellCtx

    Ambient context a command runs in.

    interface ShellCtx {
        client?: SpawnClient;
        confirm: (msg: string) => Promise<boolean>;
        now: () => number;
        provider: Provider;
    }
    Index
    client? confirm now provider
    client?: SpawnClient

    The SpawnClient, when the shell is bound to one (the terminal always is). Required by sweep, which registers a monitor-driven fan-out. Commands that only touch the provider don't need it.

    confirm: (msg: string) => Promise<boolean>

    Confirm a destructive action; UI supplies a prompt. -y bypasses.

    now: () => number

    Current time in ms (the sim/real clock the UI owns).

    provider: Provider

    Settings
    Member Visibility

    On This Page
    Properties