Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Store<S, T>

Type parameters

Hierarchy

  • EventEmitter
    • Store

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private internalFromJSON

internalFromJSON: IFromJSON<T>

Private name

name: IStringKeyOf<S>

Private state

state: State<S>

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: T, action?: string) => void): this

  • Parameters

    • event: "change"
    • listener: (state: T, action?: string) => void
        • (state: T, action?: string): void

        • Parameters

          • state: T
          • Optional action: string

          Returns void

    Returns this

emit

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

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

fromJSON

  • fromJSON(json: IJSONObject): T

getCurrent

  • getCurrent(): T

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getName

  • getName(): Extract<keyof S, string>

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: "change", listener: (state: T, action?: string) => void): this
  • off(event: "change"): this

  • Parameters

    • event: "change"
    • listener: (state: T, action?: string) => void
        • (state: T, action?: string): void

        • Parameters

          • state: T
          • Optional action: string

          Returns void

    Returns this

  • Parameters

    • event: "change"

    Returns this

on

  • on(event: "change", listener: (state: T, action?: string) => void): this

  • Parameters

    • event: "change"
    • listener: (state: T, action?: string) => void
        • (state: T, action?: string): void

        • Parameters

          • state: T
          • Optional action: string

          Returns void

    Returns this

once

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

  • 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

  • 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

  • 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[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event: "change"): this

removeListener

  • removeListener(event: "change", listener: (state: T, action?: string) => void): this

  • Parameters

    • event: "change"
    • listener: (state: T, action?: string) => void
        • (state: T, action?: string): void

        • Parameters

          • state: T
          • Optional action: string

          Returns void

    Returns this

set

  • set(newState: T, action?: string): Store

setFromJSON

  • setFromJSON(json: IJSONObject): Store

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

toJSON

  • toJSON(): T

update

  • update(updateFn: (state: T) => T, action?: string): Store

  • Parameters

    • updateFn: (state: T) => T
        • (state: T): T

        • Parameters

          • state: T

          Returns T

    • Optional action: string

    Returns Store

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc