StateBindingController

class

Back to Helios Web API

Kind

class

Source

src/state/HeliosStateManager.js:898

Description

Binding controller that keeps registered state entries synchronized with runtime owners.

Signature

export class StateBindingController {

Lifecycle

Creation, initialization, prewarming, cleanup, and renderer lifetime.

destroy()

Source: src/state/HeliosStateManager.js:988

Manages destroy for the current instance.

Utilities

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

bind(key, entry, owner = null)

Source: src/state/HeliosStateManager.js:906

Configures or reads bind.

Parameters

Name	Type	Attributes	Default	Description
key				Value passed to bind.
entry				Value passed to bind.
owner		optional	null	Value passed to bind.

apply(key, value, options = {})

Source: src/state/HeliosStateManager.js:964

Updates the apply state on the current instance.

Parameters

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

unbind(key)

Source: src/state/HeliosStateManager.js:981

Configures or reads unbind.

Parameters

Name	Type	Attributes	Default	Description
key				Value passed to unbind.