SignalOption.signal ​

Contract 2.0.0 · package sha256 a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e · generated from configurator-runtime.d.ts by services/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.

Property of SignalOption · inherited by WriteOptions, TransactionOptions, SceneModelOptions, PartWriteOptions, StageWriteOptions, CameraMoveOptions, AttachOptions, PlayOptions · stable · since 2.0.0

signal?: AbortSignal;

Cancels this call; the member's JSDoc says what an abort does. A write: before the commit point it rolls back and rejects AbortError; after it, no effect, except that a running camera move stops where the last frame drew it (CameraMoveOptions). Through a tx the commit point is the transaction's: aborting a write still loading rejects AbortError and stages nothing (catch it: unobserved, it rolls the transaction back, spec section 6.1, O6); aborting one already staged unstages it, its paths keeping the latest other write to them as after a failed savepoint (O7), and its Promise stays resolved 'staged'. A registration (on, beforeCommit): aborting removes it and nothing rejects. A wait (idle, capture): aborting rejects AbortError and nothing rolls back. A creator (collection for a new name, materials.create, on, onFrame, beforeCommit, follow, input.drag, labs.lightLinking) given a signal already aborted returns at once, already ended: a Collection or Material reading disposed: true that holds no content and no live name, or a registration that never runs and whose disposer does nothing. It records no Problem for the abort and throws only what it would throw anyway, as the DOM's addEventListener with an aborted signal adds nothing (spec section 6.5).

Default: undefined

Generic-API test (spec 3.1) ​