Function useUiStore

Properties

getInitialState getState persist subscribe

Methods

setState

Properties

getInitialState

getInitialState: () => UiState

getState

getState: () => UiState

persist

persist: {
    clearStorage: () => void;
    getOptions: () => Partial<
        PersistOptions<UiState, Partial<UiState>, unknown>,
    >;
    hasHydrated: () => boolean;
    onFinishHydration: (fn: PersistListener<UiState>) => () => void;
    onHydrate: (fn: PersistListener<UiState>) => () => void;
    rehydrate: () => void | Promise<void>;
    setOptions: (
        options: Partial<PersistOptions<UiState, Partial<UiState>, unknown>>,
    ) => void;
}

subscribe

subscribe: (
    listener: (state: UiState, prevState: UiState) => void,
) => () => void

Methods

setState

  • setState(
        ...args: [
            partial: | UiState
            | Partial<UiState>
            | (state: UiState) => UiState | Partial<UiState>,
            replace?: false,
        ],
    ): unknown

    Parameters

    • ...args: [
          partial: | UiState
          | Partial<UiState>
          | (state: UiState) => UiState | Partial<UiState>,
          replace?: false,
      ]

    Returns unknown

  • setState(
        ...args: [state: UiState | (state: UiState) => UiState, replace: true],
    ): unknown

    Parameters

    • ...args: [state: UiState | (state: UiState) => UiState, replace: true]

    Returns unknown

Settings

Member Visibility

On This Page

Properties
Methods