API 文档 / pinia / DefineStoreOptionsInPlugin

接口：DefineStoreOptionsInPlugin<Id, S, G, A> ​

pinia.DefineStoreOptionsInPlugin

创建 pinia 插件时可用的 options。

类型参数 ​

层次结构 ​

• Omit<DefineStoreOptions<Id, S, G, A>, "id" | "actions">

  ↳ DefineStoreOptionsInPlugin

属性 ​

actions ​

• actions: A

提取的 action 对象。当使用 setup API 建立 store 时，由 useStore() 添加， 否则使用传递给 defineStore() 的对象。 如果没有定义 action，则默认为一个空对象。

getters ​

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

getter 的可选对象

继承于 ​

Omit.getters

state ​

• Optional state: () => S

类型声明 ​

▸ (): S

创建一个新 state 的函数。 必须是一个箭头函数，以确保正确的类型标注!

返回值 ​

S

继承于 ​

Omit.state

方法 ​

hydrate ​

▸ Optional hydrate(storeState, initialState): void

当 store 定义中使用了复杂的 state (如仅客户端的引用)，并且从 pinia.state 中复制值是不够时， 允许在 SSR 期间对 store 进行 hydrating。

Example

如果在你的 state 中，你使用了任何 customRef，任何 computed，或任何在服务器和客户端有不同值的 ref， 你需要手动激活它们。 例如，一个存储在本地存储的自定义 ref：

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)
  }
})

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)
  }
})

参数 ​

返回值 ​

void

继承于 ​

Omit.hydrate