Interface Store<TStore>

Store itself with Context, Provider and hooks, all connected to on store type.

interface Store<TStore> {
    Type: TStore;
    useStore(): TStore["props"] & TStore["values"];
    useStore$(): null | TStore["props"] & TStore["values"];
    useSelector<TValue>(selector): TValue;
    useSelector$<TValue>(selector): null | TValue;
}

Type Parameters

TStore extends IStore<any>
Store definition (props & values).

Index

Methods

useStore useStore$ useSelector useSelector$

Properties

Methods

useStore

useStore(): TStore["props"] & TStore["values"]
Use whole store

Returns TStore["props"] & TStore["values"]
- Defined in packages/client/src/store/IStore.ts:56

useStore$

useStore$(): null | TStore["props"] & TStore["values"]
Use whole optional store

Returns null | TStore["props"] & TStore["values"]
- Defined in packages/client/src/store/IStore.ts:61

useSelector

useSelector<TValue>(selector): TValue
Use the store with a selector
Type Parameters
- TValue
Parameters
- selector: ((state) => TValue)
  - - (state): TValue
    - Parameters
      state: TStore["props"] & TStore["values"]
      Returns TValue
Returns TValue
- Defined in packages/client/src/store/IStore.ts:66

useSelector$

useSelector$<TValue>(selector): null | TValue
Use optional store with a selector
Type Parameters
- TValue
Parameters
- selector: ((state) => TValue)
  - - (state): TValue
    - Parameters
      state: TStore["props"] & TStore["values"]
      Returns TValue
Returns null | TValue
- Defined in packages/client/src/store/IStore.ts:71

Properties

Type

Type: TStore

Proxy property, only used to provide a store type.