Class RootStore<T>

See documentation at Store.

Type Parameters

T

Hierarchy (View Summary)

AbstractStore<T>
- RootStore
  - PersistentStore

RootStore<K extends string | number | symbol>(attr: K): IfCouldBe<T, Nil>
Type Parameters
- K extends string | number | symbol
Parameters
- attr: K
Returns IfCouldBe<T, Nil>
- Defined in projects/signal-store/src/lib/root-store.ts:6
RootStore(...args: [attr: keyof NonNullable<T>]): IfCouldBe<T>
Parameters
- ...args: [attr: keyof NonNullable<T>]
Returns IfCouldBe<T>
- Defined in projects/signal-store/src/lib/root-store.ts:6

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

new RootStore<T>(state: T): RootStore<T>
Type Parameters
- T
Parameters
- state: T
Returns RootStore<T>
Overrides AbstractStore<T>.constructor
- Defined in projects/signal-store/src/lib/root-store.ts:9

Properties

assign

assign: IfCouldBe<
    T,
    any[]
    | Nil
    | Primitive,
    never,
    (value: Partial<T>) => void,
> = ...

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

Accessors

nonNull

get nonNull(): Store<NonNullable<T>>
Returns Store<NonNullable<T>>
Inherited from AbstractStore.nonNull
- Defined in projects/signal-store/src/lib/abstract-store.ts:35

state

get state(): T
Get the current state of this store object. This is backed by a signal, so it will trigger change detection when accessed in templates, etc.

Returns T
Overrides AbstractStore.state
- Defined in projects/signal-store/src/lib/root-store.ts:24
set state(value: T): void
Change the value of this store.
Parameters
- value: T
Returns void
Overrides AbstractStore.state
- Defined in projects/signal-store/src/lib/root-store.ts:31

Methods

mutate

mutate<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
Inherited from AbstractStore.mutate
- Defined in projects/signal-store/src/lib/abstract-store.ts:53

update

update<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
Inherited from AbstractStore.update
- Defined in projects/signal-store/src/lib/abstract-store.ts:44