Class Store<T>Abstract

Readonly $

getRootStore

assign

• assign(value): void

• Assigns the given values to state of this store object. The resulting state will be like Object.assign(store.state(), value).

  Parameters

  • value: Partial<T>

  Returns void

Abstract delete

• delete(): void

• Removes the state represented by this store object from its parent. E.g. to remove the current user:

  store('currentUser').delete();
  Copy

  Returns void

mutateUsing

• mutateUsing<A>(func, ...args): void

• Runs func on a shallow clone of the state, replacing the state with the clone. The first argument to func will be the cloned state, followed by the arguments in args.

  WARNING: You SHOULD NOT use a function that will mutate nested objects within the state.

  Type Parameters

  • A extends any[]

  Parameters

  • func: ((state, ...args) => void)
    • • (state, ...args): void

      • Parameters

        • state: T
        • Rest ...args: A

        Returns void

  • Rest ...args: A

  Returns void

Abstract refersToSameStateAs

• refersToSameStateAs(other): boolean

• Parameters

  • other: Store<T>

  Returns boolean

  whether the given Store operates on the same slice of the store as this object.

Abstract set

• set(value): void

• Replace the state represented by this store object with the given value.

  Parameters

  • value: T

  Returns void

setUsing

• setUsing<A>(func, ...args): void

• Runs func on the state and replaces it with the return value. The first argument to func will be the state, followed by the arguments in args.

  WARNING: You SHOULD NOT use a function that will mutate the state.

  Type Parameters

  • A extends any[]

  Parameters

  • func: ((state, ...args) => T)
    • • (state, ...args): T

      • Parameters

        • state: T
        • Rest ...args: A

        Returns T

  • Rest ...args: A

  Returns void

Abstract state

• state(): T

• Retrieve the current state represented by this store object.

  Returns T