Graphty

Appearance

@graphty/graphty-element / session / RunOptions

Interface: RunOptions ​

Defined in: graphty-element/src/session/runs/types.ts:345

What any started work accepts.

Declared beside Progress because onProgress is what makes it worth passing. It is the same type the command executor takes when that lands; there is one of it, not two.

Extended by ​

Properties ​

dryRun? ​

readonly optional dryRun?: boolean

Defined in: graphty-element/src/session/runs/types.ts:353

Ask what this would do and cost instead of doing it. Nothing is performed.

onProgress? ​

readonly optional onProgress?: (progress) => void

Defined in: graphty-element/src/session/runs/types.ts:349

Called as the work advances, with the run's current progress.

Parameters ​

progress ​

Progress

Returns ​

void

queue? ​

readonly optional queue?: "replace" | "append" | "now"

Defined in: graphty-element/src/session/runs/types.ts:351

How the call joins the queue. Defaults to "append".

signal? ​

readonly optional signal?: AbortSignal

Defined in: graphty-element/src/session/runs/types.ts:347

A signal that cancels the work. Cancelling rejects with an AbortError.

transitionMs? ​

readonly optional transitionMs?: number

Defined in: graphty-element/src/session/runs/types.ts:355

Override the configured transition duration for this call only, in milliseconds.