import StateStore from 'devapt-core-common/js/state_store/state_store.js'

public class | source

StateStore

Extends:

Loggable → StateStore

Direct Subclass:

MapStore, ReduxStore

Indirect Subclass:

RegistryStore, TopologyRegistry

Base class to deal with state storing and mutations.

Constructor Summary

Public Constructor
public	constructor(arg_log_context: string, arg_logger_manager: LoggerManager): nothing Create a state Store instance.

Member Summary

Public Members
public	is_mutable: boolean
public	use_immutable: boolean

Method Summary

Public Methods
public abstract	dispatch(arg_action: object): nothing Dispatch a requested action to mutate current state.
public	dispatch_action(arg_action: object): nothing Dispatch a state action.
public abstract	get_state(): object Get current state.
public abstract	set_state(arg_state: object): nothing Set/Replace current state.
public abstract	subscribe(arg_handle: function): function Register a handle on state mutations.

Inherited Summary

From class Loggable
public	$context: string Log context.
public	is_loggable: boolean Class type flag.
public	is_trace_enabled: boolean Trace is enabled for this flag.
private	_logger_manager: LoggerManager Logger manager instance (default undefined)
public	debug(args: string \| array): nothing Trace DEBUG formatted message.
public	disable_trace(): nothing Disable traces.
public	enable_trace(): nothing Enable traces.
public	enter_group(arg_group: string): nothing Trace INFO message on "enter trace group".
public	error(args: string \| array): nothing Trace ERROR formatted message.
public	get_class(): string Define get class name method for non Instance classes.
public	get_context(): string Get instance context.
public	get_logger_manager(): LoggerManager Get logger manager.
public	get_name(): string Define get instance name method for non Instance classes.
public	get_trace(): boolean Get trace flag.
public	info(args: string \| array): nothing Trace INFO formatted message.
public	leave_group(arg_group: string): nothing Trace INFO message on "leave trace group".
public	separate_level_1(): nothing Trace INFO trace level 1 separator.
public	separate_level_2(): nothing Trace INFO trace level 2 separator.
public	separate_level_3(): nothing Trace INFO trace level 3 separator.
public	set_trace(arg_value: boolean): nothing Set trace flag.
public	should_trace(arg_traces_cfg: object): boolean Calculate should trace flag.
public	should_trace_class(arg_traces_cfg: object): boolean Calculate should trace flag for classes.
public	should_trace_collection_item(arg_traces_cfg: object, arg_collection_name: string, arg_this_item_accessor: string): boolean Calculate should trace flag for given collection of names or patterns.
public	should_trace_module(arg_traces_cfg: object): boolean Calculate should trace flag for modules.
public	should_trace_name(arg_traces_cfg: object): boolean Calculate should trace flag for instances names.
public	toggle_trace(): boolean Toggle trace flag.
public	update_trace_enabled(): nothing Update trace enabled flag.
public	warn(args: string \| array): nothing Trace WARN formatted message.

Public Constructors

public constructor(arg_log_context: string, arg_logger_manager: LoggerManager): nothing source

Create a state Store instance.

Override:

Loggable#constructor

Params:

Name	Type	Attribute	Description
arg_log_context	string		trace context.
arg_logger_manager	LoggerManager		logger manager object (optional).

Return:

nothing

Public Members

public is_mutable: boolean source

public use_immutable: boolean source

Public Methods

public abstract dispatch(arg_action: object): nothing source

Dispatch a requested action to mutate current state.

Params:

Name	Type	Attribute	Description
arg_action	object		action record: { type:'...', ... }.

Return:

nothing

public dispatch_action(arg_action: object): nothing source

Dispatch a state action.

Params:

Name	Type	Attribute	Description
arg_action	object		action object with a 'type' attribute.

Return:

nothing

public abstract get_state(): object source

Get current state.

Return:

object

public abstract set_state(arg_state: object): nothing source

Set/Replace current state.

Params:

Name	Type	Attribute	Description
arg_state	object		new state.

Return:

nothing

Params:

Name	Type	Attribute	Description
arg_handle	function		state changes handle as f(old_state, new_state).

Return:

function

unsubscribe function

StateStore

Extends:

Direct Subclass:

Indirect Subclass:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(arg_log_context: string, arg_logger_manager: LoggerManager): nothing source

Override:

Params:

Return:

Public Members

public is_mutable: boolean source

public use_immutable: boolean source

Public Methods

public abstract dispatch(arg_action: object): nothing source

Params:

Return:

public dispatch_action(arg_action: object): nothing source

Params:

Return:

public abstract get_state(): object source

Return:

public abstract set_state(arg_state: object): nothing source

Params:

Return:

public abstract subscribe(arg_handle: function): function source

Params:

Return: