StateTransaction

class

Back to Helios Web API

Kind

class

Source

src/state/HeliosStateManager.js:799

Description

Helper passed to HeliosStateManager.transaction() for grouped state writes.

Signature

export class StateTransaction {

Configuration

General configuration setters and compatibility helpers.

set(key, value, options = {}) → {this}

Source: src/state/HeliosStateManager.js:806

Set the set setting.

Parameters

Name	Type	Attributes	Default	Description
key				Value passed to set.
value				New set value. Omit this argument to read the current value.
options	Object	optional	{}	Options object for this operation.

Returns

This instance.

Type this

reset(keyOrPrefix, options = {}) → {this}

Source: src/state/HeliosStateManager.js:812

Updates the reset state on the current instance.

Parameters

Name	Type	Attributes	Default	Description
keyOrPrefix				Value passed to reset.
options	Object	optional	{}	Options object for this operation.

Returns

This instance.

Type this

Utilities

Additional public helpers that do not belong to a narrower API area.

result()

Source: src/state/HeliosStateManager.js:816

Configures or reads result.