Sign up (with export icon)

AIRunResult

Api-class iconclass

Container returned by any per-root AI run. Wraps one AIRunSingleRootResult (or feature-specific subclass) per root when the run completes successfully; on whole-run failures (transport / parse errors or abort) the results array stays empty and the outcome is described by status and error.

Type parameters

Properties

  • Chevron-right icon

    error : Error | undefined

    The error that caused the whole run to fail. Undefined when the run completed successfully or was aborted.

    When the failure originated in the AI service backend, its structured response (for example, an issues list describing which fields failed validation) is available under error.data.backendData.

    Parameters

    value : CKEditorError
  • results : Array<SubResultType>
    readonly

  • Chevron-right icon

    Outcome of the whole run — driven explicitly by the runner. Per-root sub-results carry their own status / error; consult results for per-root outcomes.

    Parameters

    value : AIRunStatus

Methods

  • Chevron-right icon

    constructor( results )

    Type parameters

    SubResultType : extends AIRunSingleRootResult

    Parameters

    results : Array<SubResultType>

    Defaults to []

  • Chevron-right icon

    abort() → void

    Marks the run as aborted. Reflected via status. No-op when the run has already errored — a concrete error is more informative to the integrator than a subsequent abort.

    Returns

    void
  • Chevron-right icon

    addResult( results ) → void

    Appends one or more per-root sub-results to the multi.

    Parameters

    results : Array<SubResultType>

    Returns

    void