mise API - v0.0.0
    Preparing search index...

    Interface PluginInstanceHandle

    Typed handle over one plugin-instance detail resource.

    Wraps the live chrisapi resource so callers can read its payload and drive its lifecycle without touching the unsafe object.

    interface PluginInstanceHandle {
        data: PluginInstanceData | null;
        delete(): Promise<void>;
        logs_get(): Promise<string | null>;
        parametersPage_get(
            params: { limit: number; offset: number },
        ): Promise<ListPage<InstanceParameterData>>;
        status_set(status: string): Promise<void>;
    }
    Index
    data: PluginInstanceData | null

    The instance's wire payload, or null when the resource carries none (the sub-resources and lifecycle methods still work).

    • Fetches the instance's log text via its logs sub-resource.

      Returns Promise<string | null>

      The joined log text, or null when this instance's resource does not expose logs.

    • Writes a new status to the instance (e.g. cancelled).

      Parameters

      • status: string

        The status string to PUT.

      Returns Promise<void>