Interface Engine

Processing interface for controllers and custom integrations. Implementation objects and their resources are never serialized into sessions.

interface Engine {
    limits?: Readonly<Limits>;
    dispose(): void;
    run(
        request: EngineRequest,
        tag: JobTag,
        options?: EngineRunOptions,
    ): Promise<EngineResult>;
}

Index

Methods

dispose run

Properties

limits?

Methods

dispose

dispose(): void
Cancel all active and queued jobs owned by this engine. The built-in engine permits subsequent runs.

Returns void
- Defined in packages/core/src/engine/index.ts:205

run

run(
    request: EngineRequest,
    tag: JobTag,
    options?: EngineRunOptions,
): Promise<EngineResult>
Run one tagged operation. AbortSignal cancellation rejects with AbortError; other processing failures reject with structured errors.
Parameters
- request: EngineRequest
  Operation payload.
- tag: JobTag
  Identity used to reject stale worker messages.
- Optionaloptions: EngineRunOptions
  Cancellation and progress callbacks.
Returns Promise<EngineResult>
Fields corresponding to the request kind.
- Defined in packages/core/src/engine/index.ts:196

Properties

`Optional` `Readonly`limits

limits?: Readonly<Limits>

Effective workload limits, when known. Controllers use maxGcps to reject edits beyond the engine budget before fitting; custom engines may omit this.

Interface Engine

Index

Methods

Properties

Methods

dispose

Returns void

run

Parameters

Returns Promise<EngineResult>

Properties

`Optional` `Readonly`limits

Settings

On This Page

Interface Engine

Index

Methods

Properties

Methods

dispose

Returns void

run

Parameters

Returns Promise<EngineResult>

Properties

Optional Readonlylimits

Settings

On This Page

`Optional` `Readonly`limits