Interface UseImmerStore<T>

interface UseImmerStore {
    destroy: (() => void);
    getState: (() => T);
    setState: SetImmerState<T>;
    subscribe: ((listener) => (() => void));
    (): T;
    <U>(selector, equalityFn?): U;
}

Type Parameters

T extends State

Hierarchy

Omit<UseBoundStore<RawStoreApi<T>>, "setState">
- UseImmerStore

UseImmerStore(): T
Returns T
- Defined in packages/zustand-x/src/types.ts:122
UseImmerStore<U>(selector, equalityFn?): U
Type Parameters
- U
Parameters
- selector: StateSelector<T, U>
- Optional equalityFn: EqualityChecker<U>
Returns U
- Defined in packages/zustand-x/src/types.ts:124

Index

Properties

destroy getState setState subscribe

Properties

destroy

destroy: (() => void)

Type declaration

- (): void
- Returns void
  Deprecated
  Use unsubscribe returned by subscribe

getState

getState: (() => T)

Type declaration

- (): T
- Returns T

setState

setState: SetImmerState<T>

subscribe

subscribe: ((listener) => (() => void))

Type declaration

- (listener): (() => void)
- Parameters
  - listener: ((state, prevState) => void)
    - (state, prevState): void
      Parameters
      state: T
      prevState: T
      Returns void
  Returns (() => void)
  - - (): void
    - Returns void

Generated using TypeDoc