'committed' Contract 2.0.0 · package sha256
a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e· generated fromconfigurator-runtime.d.tsandtables/problems.jsonbyservices/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.
A member of Outcome · stable · since 2.0.0
passed its commit point; irrevocable. changed: false when its result equalled the current state, so nothing was recorded.
Animations.play: Outcome: 'committed' when it ends or holds its last frame; with loop: true, once it has started.AttachReport: Re-attaching a pair that is already connected and in place is an equal write: it resolves attached: true with that connection, outcome: 'committed', changed: false and seq: null, and makes no undo step and no event (spec section 6.1, O15).Camera: Autocommit: resolves when the move ends (at rest); a newer view write takes over a move in progress, which then resolves 'committed', and so does a shopper's pointer or touch gesture ('camera:control-start'; a wheel is not one).Camera.set: Outcome: 'committed' when the move ends, or when a newer view write or a shopper's pointer or touch gesture ('camera:control-start'; not a wheel, which only changes the distance the move lands at) takes it over, so 'committed' does not say the view landed; through a tx, 'deferred'.ClipInfo: A door or drawer button keeps that state itself: set it from 'animation:finished' (the end of its play's direction: the end, or frame 0 for a reverse play), never from play's Promise, which also resolves 'committed' when a stop cuts the play short.DragOptions.commit: A pending write that would change that pose or at but is superseded (spec section 6.1, O2c) passes the release to the write that superseded it, which releases the unit when it resolves 'committed', equal or not, so a store undo whose sync overtakes the drop's sync shows the scene model's pose.Events: A payload may also predate a write you have since called: never merge a whole snapshot over newer app state (the setSceneModel example merges each commit's patch from 'committed', never its whole model).Events.scene-model:changed: It is the whole model as of this commit, which can predate a newer document of yours (Cause.seq): a store that writes the model too merges only what each commit changed, 'committed''s patch (the setSceneModel sync example).Frame.camera: A transient camera view for the frame being drawn: no commit, no 'committed' event, no undo step.HoloTransactionClosedError.closedBy: 'threw': work threw; 'aborted': its signal aborted or el left the document; 'committed' for a savepoint's sp that staged.Overlays: A call made inside work is never staged, joined or rolled back: a rollback or a supersede keeps the last call, which then shows over the old scene, so set overlays for a generated product after its write resolves 'committed'.PartState.outline: To outline the product as a whole, as 1.x's highlight did (it resolved the hovered mesh to its model root), write it from your 'hover' handler on the hovered part's model root (node(hit.part.node)), or for a collection part on its collection's root (or its item, part(key), when each item is a product), and only when that changes: 'hover' fires whenever the part under the pointer changes,…Session.beforeCommit: Not for: reacting after a commit, which is on('committed').Session.canTryOn: Show a Try-on control only when available, and read it again on 'committed': the try-on rig belongs to the product's ModelNode.Session.capture: Throws HoloScopeError inside a beforeCommit function: it would wait for that function's own commit (spec section 6.1, O3); capture on 'committed' or after the write's Promise.Session.idle: Each of these settles exactly when its write has landed: - one write: its own Promise, at its commit point, its loads included; a camera move, a clip or a durationMs tween resolves when it finishes ('superseded': a newer write won); - the newest of a burst (a slider, fast swatch clicks): abort the older write's signal when a new one starts, and await the newest; never debounce to let the…Session.redo: As undo: in the write queue; ends an open group at its call; always moves the history pointer, except on 'rolled-back' / 'internal-error'; 'committed', or 'refused' with reason 'empty'.Session.transaction: - A transaction whose result equals the current state commits nothing ('committed', changed: false); its deferred camera moves and clips still start, at the next drawn frame.Session.undo: Outcome: 'committed', or 'refused' with reason 'empty'.Writer.applyPatch: Outcome: 'committed' at its commit point, after its loads; through a tx, 'staged' once the assets it names have loaded (a node it enables, a new glbUrl).Writer.select: Outcome: 'committed' at its commit point, after its loads; through a tx, 'staged' once the assets it names have loaded (asset failures: problems).Writer.setSceneModel: Outcome: 'committed' at its commit point, after its loads; through a tx, 'staged' once loaded; 'rolled-back' with reason 'internal-error' when applying it failed inside the runtime (through a tx, it then rejects AbortError and the transaction resolves 'rolled-back'; spec section 6.4).The set is open: handle a code you don't know ('other').