Class Store<T>Abstract

constructor

• new Store<T>(
      getRootStore: () => RootStore<object>,
      makeChild: (
          getRootStore: () => RootStore<object>,
          parent: Store<any>,
          key: any,
      ) => Store<unknown>,
  ): Store<T>

  Type Parameters

  • T

  Parameters

  • getRootStore: () => RootStore<object>
  • makeChild: (
        getRootStore: () => RootStore<object>,
        parent: Store<any>,
        key: any,
    ) => Store<unknown>

  Returns Store<T>

Readonly$

getRootStore

assign

• assign(value: Partial<T>): 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

Abstractdelete

• 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 extends any[]>(
      func: (state: T, ...args: A) => void,
      ...args: A,
  ): 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: T, ...args: A) => void
  • ...args: A

  Returns void

AbstractrefersToSameStateAs

• refersToSameStateAs(other: Store<T>): boolean

  Parameters

  • other: Store<T>

  Returns boolean

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

Abstractset

• set(value: T): void

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

  Parameters

  • value: T

  Returns void

setUsing

• setUsing<A extends any[]>(func: (state: T, ...args: A) => T, ...args: A): 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: T, ...args: A) => T
  • ...args: A

  Returns void

Abstractstate

• state(): T

  Retrieve the current state represented by this store object.

  Returns T