On this page

State

State class. Parent state class. Extend this class for your state logic.

Constructor

new State(app, routeParamsopt, parentStateopt)

Parameters:

Name	Type	Attributes	Default	Description
`app`	App			App instance
`routeParams`	RouteParams	<optional>		Current route params
`parentState`	State	<optional>	null	Parent state for sub-states

Source: base/State.js, line 18

Example

Create a state called MyState with is executed when the url 'my-state' is called. When executed,
it prints 'Hello from MyState' to the console.

class MyState extends State
{
    asnyc enter()
    {
        console.log( "Hello from MyState" );
    }
}

Members

ID :string|null

ID of state. Should be an unique identifier. If not set it will be auto-generated.

Type:

string | null

Source: base/State.js, line 24

ROUTE :string|array

Route(s) which trigger this state

Type:

string | array

Source: base/State.js, line 30

Methods

addEventListener(target, type, listener, options)

Add event listener with automatic cleanup tracking

Parameters:

Name	Type	Default	Description
`target`	EventTarget		Event target (element, window, document, etc.)
`type`	string		Event type
`listener`	function		Event listener function
`options`	boolean \| object	false	Event listener options

Source: base/State.js, line 352

canEnter() → {boolean}

Called before entering state.

Source: base/State.js, line 66

Returns:

Type:: boolean

canExit() → {boolean}

Called before exiting state. Return false to prevent state transition. Also checks if sub-states can exit.

Source: base/State.js, line 77

Returns:

True to allow exit, false to prevent exit

Type:: boolean

clearInterval(intervalId)

Clear specific interval

Parameters:

Name	Type	Description
`intervalId`	number	Interval ID to clear

Source: base/State.js, line 407

clearTimeout(timeoutId)

Clear specific timeout

Parameters:

Name	Type	Description
`timeoutId`	number	Timeout ID to clear

Source: base/State.js, line 438

(async) createSubStateManager() → {Promise.<StateManager>}

Create a sub-state manager for nested states

Source: base/State.js, line 197

Returns:

Sub-state manager instance

Type:: Promise.<StateManager>

(async) dispose() → {Promise.<void>}

Dispose of the state and cleanup all resources Called automatically by StateManager when exiting state Handles hierarchical cleanup of sub-states Override onDispose() for custom cleanup logic

Source: base/State.js, line 463

Returns:

Type:: Promise.<void>

(async) enter() → {Promise.<void>}

Called when entering scene and after canEnter() call returned true.

Source: base/State.js, line 110

Returns:

Type:: Promise.<void>

(async) exit() → {Promise.<void>}

Called when exiting scene and after canExit() call return true. Also handles sub-state cleanup.

Source: base/State.js, line 129

Returns:

Type:: Promise.<void>

findStateInHierarchy(stateId, visited) → {State|null}

Find a state in the hierarchy by ID

Parameters:

Name	Type	Description
`stateId`	string	State ID to find
`visited`	Set	Set of already visited states (internal use)

Source: base/State.js, line 316

Returns:

Found state or null

Type:: State | null

getCurrentSubState() → {State|null}

Get current sub-state

Source: base/State.js, line 240

Returns:

Type:: State | null

getFullStatePath() → {Array.<string>}

Get full state path including current sub-state

Source: base/State.js, line 297

Returns:

Complete path including sub-states

Type:: Array.<string>

getId() → {string}

Return current ID

Source: base/State.js, line 57

Returns:

Type:: string

getRedirectUrl() → {string|null}

Called when canEnter() function returns false.

Source: base/State.js, line 101

Returns:

Return redirect route.

Type:: string | null

getRootState() → {State}

Get the root state (top-level parent)

Source: base/State.js, line 267

Returns:

Type:: State

getStateData() → {*}

Get data for this state

Source: base/State.js, line 188

Returns:

State data

Type:: *

getStatePath() → {Array.<string>}

Get state path (hierarchy chain)

Source: base/State.js, line 280

Returns:

Array of state IDs from root to current

Type:: Array.<string>

hasActiveSubState() → {boolean}

Check if this state has an active sub-state

Source: base/State.js, line 258

Returns:

Type:: boolean

hasSubStates() → {boolean}

Check if this state has sub-states

Source: base/State.js, line 249

Returns:

Type:: boolean

isDisposed() → {boolean}

Check if state has been disposed

Source: base/State.js, line 451

Returns:

True if state is disposed

Type:: boolean

onCanExit() → {boolean}

Override this method for custom exit validation logic

Source: base/State.js, line 92

Returns:

True to allow exit, false to prevent exit

Type:: boolean

(async) onDispose() → {Promise.<void>}

Override this method for custom cleanup logic Called before automatic resource cleanup in dispose()

Source: base/State.js, line 538

Returns:

Type:: Promise.<void>

(async) onEnter() → {Promise.<void>}

Override this method for custom enter logic

Source: base/State.js, line 119

Returns:

Type:: Promise.<void>

(async) onExit() → {Promise.<void>}

Override this method for custom exit logic

Source: base/State.js, line 150

Returns:

Type:: Promise.<void>

removeEventListener(target, type, listener, options)

Remove specific event listener

Parameters:

Name	Type	Default	Description
`target`	EventTarget		Event target
`type`	string		Event type
`listener`	function		Event listener function
`options`	boolean \| object	false	Event listener options

Source: base/State.js, line 370

setInterval(callback, delay) → {number}

Set interval with automatic cleanup tracking

Parameters:

Name	Type	Description
`callback`	function	Callback function
`delay`	number	Delay in milliseconds

Source: base/State.js, line 391

Returns:

Interval ID

Type:: number

setStateData(data)

Set data for this state (used for data transfer between states)

Parameters:

Name	Type	Description
`data`	*	Data to set

Source: base/State.js, line 179

setTimeout(callback, delay) → {number}

Set timeout with automatic cleanup tracking

Parameters:

Name	Type	Description
`callback`	function	Callback function
`delay`	number	Delay in milliseconds

Source: base/State.js, line 422

Returns:

Timeout ID

Type:: number

(async) switchToSubState(subStateId, stateData) → {Promise.<boolean>}

Switch to a sub-state

Parameters:

Name	Type	Default	Description
`subStateId`	string		Sub-state ID to switch to
`stateData`	*	null	Data to pass to sub-state

Source: base/State.js, line 213

Returns:

Type:: Promise.<boolean>