State | @aicacia/state

Type parameters

Hierarchy

EventEmitter
- State

Index

Constructors

constructor

Properties

Constructors

constructor

new State<T>(initialState: T, fromJSONs: Record<IStringKeyOf<T>, IFromJSON<T[IStringKeyOf<T>]>>): State

- Defined in src/State.ts:55
Type parameters
- T
Parameters
- initialState: T
- fromJSONs: Record<IStringKeyOf<T>, IFromJSON<T[IStringKeyOf<T>]>>
Returns State

Properties

Record

Record: ImmutableRecord.Factory<T>

StoresRecord

StoresRecord: ImmutableRecord.Factory<IStores<T>>

current

current: RecordOf<T>

stores

stores: RecordOf<IStores<T>>

Static defaultMaxListeners

defaultMaxListeners: number

Readonly Static errorMonitor

errorMonitor: unique symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

addListener(event: "change", listener: (state: RecordOf<T>, action?: string) => void): this
addListener(event: "change-for", listener: (state: RecordOf<T>, name: string, action?: string) => void): this

- Defined in src/State.ts:18
Parameters
- event: "change"
- listener: (state: RecordOf<T>, action?: string) => void
  - - (state: RecordOf<T>, action?: string): void
    - Parameters
      - state: RecordOf<T>
      - Optional action: string
      Returns void
Returns this
- Defined in src/State.ts:22
Parameters
- event: "change-for"
- listener: (state: RecordOf<T>, name: string, action?: string) => void
  - - (state: RecordOf<T>, name: string, action?: string): void
    - Parameters
      - state: RecordOf<T>
      - name: string
      - Optional action: string
      Returns void
Returns this

clear

clear(): State

- Defined in src/State.ts:90
Returns State

emit

emit(event: string | symbol, ...args: any[]): boolean

- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

fromJSON

fromJSON(json: IJSONObject): State

- Defined in src/State.ts:132
Parameters
- json: IJSONObject
Returns State

getCurrent

getCurrent(): RecordOf<T>

- Defined in src/State.ts:82
Returns RecordOf<T>

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/@types/node/events.d.ts:69
Returns number

getStore

getStore<K>(name: K): Store<T, T[K]>

- Defined in src/State.ts:86
Type parameters
- K: string
Parameters
- name: K
Returns Store<T, T[K]>

listenerCount

listenerCount(event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: "change", listener: (state: RecordOf<T>, action?: string) => void): this
off(event: "change-for", listener: (state: RecordOf<T>, name: string, action?: string) => void): this
off(event: "change"): this
off(event: "change-for"): this

- Defined in src/State.ts:26
Parameters
- event: "change"
- listener: (state: RecordOf<T>, action?: string) => void
  - - (state: RecordOf<T>, action?: string): void
    - Parameters
      - state: RecordOf<T>
      - Optional action: string
      Returns void
Returns this
- Defined in src/State.ts:30
Parameters
- event: "change-for"
- listener: (state: RecordOf<T>, name: string, action?: string) => void
  - - (state: RecordOf<T>, name: string, action?: string): void
    - Parameters
      - state: RecordOf<T>
      - name: string
      - Optional action: string
      Returns void
Returns this
- Defined in src/State.ts:34
Parameters
- event: "change"
Returns this
- Defined in src/State.ts:35
Parameters
- event: "change-for"
Returns this

on

on(event: "change", listener: (state: RecordOf<T>, action?: string) => void): this
on(event: "change-for", listener: (state: RecordOf<T>, name: string, action?: string) => void): this

- Defined in src/State.ts:10
Parameters
- event: "change"
- listener: (state: RecordOf<T>, action?: string) => void
  - - (state: RecordOf<T>, action?: string): void
    - Parameters
      - state: RecordOf<T>
      - Optional action: string
      Returns void
Returns this
- Defined in src/State.ts:14
Parameters
- event: "change-for"
- listener: (state: RecordOf<T>, name: string, action?: string) => void
  - - (state: RecordOf<T>, name: string, action?: string): void
    - Parameters
      - state: RecordOf<T>
      - name: string
      - Optional action: string
      Returns void
Returns this

once

once(event: string | symbol, listener: (...args: any[]) => void): this

- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): this

- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event: "change" | "change-for"): this

- Defined in src/State.ts:44
Parameters
- event: "change" | "change-for"
Returns this

removeListener

removeListener(event: "change", listener: (state: RecordOf<T>, action?: string) => void): this
removeListener(event: "change-for", listener: (state: RecordOf<T>, name: string, action?: string) => void): this

- Defined in src/State.ts:36
Parameters
- event: "change"
- listener: (state: RecordOf<T>, action?: string) => void
  - - (state: RecordOf<T>, action?: string): void
    - Parameters
      - state: RecordOf<T>
      - Optional action: string
      Returns void
Returns this
- Defined in src/State.ts:40
Parameters
- event: "change-for"
- listener: (state: RecordOf<T>, name: string, action?: string) => void
  - - (state: RecordOf<T>, name: string, action?: string): void
    - Parameters
      - state: RecordOf<T>
      - name: string
      - Optional action: string
      Returns void
Returns this

set

set(newState: RecordOf<T>, action?: string): State

- Defined in src/State.ts:96
Parameters
- newState: RecordOf<T>
- Optional action: string
Returns State

setFor

setFor(name: IStringKeyOf<T>, newState: T[IStringKeyOf<T>], action?: string): State

- Defined in src/State.ts:103
Parameters
- name: IStringKeyOf<T>
- newState: T[IStringKeyOf<T>]
- Optional action: string
Returns State

setMaxListeners

setMaxListeners(n: number): this

- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

toJS

toJS(): IJSONObject

- Defined in src/State.ts:126
Returns IJSONObject

toJSON

toJSON(): T

- Defined in src/State.ts:129
Returns T

update

update(updateFn: (state: RecordOf<T>) => RecordOf<T>, action?: string): State

- Defined in src/State.ts:111
Parameters
- updateFn: (state: RecordOf<T>) => RecordOf<T>
  - - (state: RecordOf<T>): RecordOf<T>
    - Parameters
      - state: RecordOf<T>
      Returns RecordOf<T>
- Optional action: string
Returns State

updateFor

updateFor(name: IStringKeyOf<T>, updateFn: (state: T[IStringKeyOf<T>]) => T[IStringKeyOf<T>], action?: string): State

- Defined in src/State.ts:114
Parameters
- name: IStringKeyOf<T>
- updateFn: (state: T[IStringKeyOf<T>]) => T[IStringKeyOf<T>]
  - - (state: T[IStringKeyOf<T>]): T[IStringKeyOf<T>]
    - Parameters
      - state: T[IStringKeyOf<T>]
      Returns T[IStringKeyOf<T>]
- Optional action: string
Returns State

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Type parameters

T

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

T

Parameters

initialState: T

fromJSONs: Record<IStringKeyOf<T>, IFromJSON<T[IStringKeyOf<T>]>>

Returns State

Properties

Record

StoresRecord

current

stores

Static defaultMaxListeners

Readonly Static errorMonitor

Methods

addListener

Parameters

event: "change"

listener: (state: RecordOf<T>, action?: string) => void

Parameters

state: RecordOf<T>

Optional action: string

Returns void

Returns this

Parameters

event: "change-for"

listener: (state: RecordOf<T>, name: string, action?: string) => void

Parameters

state: RecordOf<T>

name: string

Optional action: string

Returns void

Returns this

clear

Returns State

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

fromJSON

Parameters

json: IJSONObject

Returns State

getCurrent

Returns RecordOf<T>

getMaxListeners

Returns number

getStore

Type parameters

K: string

Parameters

name: K

Returns Store<T, T[K]>

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: "change"

listener: (state: RecordOf<T>, action?: string) => void

Parameters

state: RecordOf<T>

Optional action: string

Returns void