Interface DefineStoreOptionsInPlugin<Id, S, G, A>

Available options when creating a pinia plugin.

interface DefineStoreOptionsInPlugin<Id, S, G, A> {
    actions: A;
    getters?: G & ThisType<UnwrapRef<S> & _StoreWithGetters<G> & PiniaCustomProperties<string, StateTree, _GettersTree<StateTree>, _ActionsTree>> & _GettersTree<S>;
    state?: (() => S);
    hydrate?(storeState, initialState): void;
}

Type Parameters

Hierarchy

Properties

actions getters? state?

Methods

hydrate?

Properties

actions

actions: A

Extracted object of actions. Added by useStore() when the store is built using the setup API, otherwise uses the one passed to defineStore(). Defaults to an empty object if no actions are defined.

Optional getters

getters?: G & ThisType<UnwrapRef<S> & _StoreWithGetters<G> & PiniaCustomProperties<string, StateTree, _GettersTree<StateTree>, _ActionsTree>> & _GettersTree<S>

Optional object of getters.

Optional state

state?: (() => S)

Function to create a fresh state. Must be an arrow function to ensure correct typings!

Type declaration

    • (): S

    • Function to create a fresh state. Must be an arrow function to ensure correct typings!

      Returns S

Methods

Optional hydrate

  • hydrate(storeState, initialState): void

  • Allows hydrating the store during SSR when complex state (like client side only refs) are used in the store definition and copying the value from pinia.state isn't enough.

    Parameters

    Returns void

    Example

    If in your state, you use any customRefs, any computeds, or any refs that have a different value on Server and Client, you need to manually hydrate them. e.g., a custom ref that is stored in the local storage:

    const useStore = defineStore('main', {
      state: () => ({
        n: useLocalStorage('key', 0)
      }),
      hydrate(storeState, initialState) {
        // @ts-expect-error: https://github.com/microsoft/TypeScript/issues/43826
        storeState.n = useLocalStorage('key', 0)
      }
    })

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc