API 文档 / pinia / _StoreWithState

接口：_StoreWithState<Id, S, G, A> #

pinia._StoreWithState

具有 state 和功能的基础 store。不应直接使用。

类型参数 #

层次结构 #

• StoreProperties<Id>

  ↳ _StoreWithState

属性 #

$id #

• $id: Id

store 的唯一标识符

继承于 #

StoreProperties.$id

定义于 #

pinia/src/types.ts:265

$state #

• $state: UnwrapRef<S> & PiniaCustomStateProperties<S>

Store 的 State。设置它可替换整个 state。

定义于 #

pinia/src/types.ts:337

方法 #

$dispose #

▸ $dispose(): void

停止 store 的相关影响作用域，并从 store 注册表中删除它。 插件可以覆盖此方法来清理已添加的任何效果。例如， devtools 插件停止显示来自 devtools 的已停止的 store。

返回值 #

void

定义于 #

pinia/src/types.ts:425

$onAction #

▸ $onAction(callback, detached?): () => void

设置一个回调，当一个 action 即将被调用时，就会被调用。 回调接收一个对象， 其包含被调用 action的所有相关信息：

• store: 被调用的 store
• name: action 的名称
• args: 传递给 action 的参数

在这些之上，它接收两个函数， 允许在 action 完成或失败时设置回调。

它还会返回一个函数来删除回调。 请注意，当在组件内调用 store.$onAction() 时，除非 detached 被设置为 true， 否则当组件被卸载时，它将被自动清理掉。

example

store.$onAction(({ after, onError }) => {
 // 在这里，你可以在所有的钩子之间共享变量，
 // 同时设置 watcher 和清理它们。
 after((resolvedValue) => {
   // 可以用来清理副作用 
   // `resolvedValue` 是 action 返回的值，
   // 如果是一个 Promise，它将是已解决的值
 })
 onError((error) => {
   // 可以用于向上传递错误
 })
})

参数 #

返回值 #

fn

删除 watcher 的函数

▸ (): void

设置一个回调，当一个 action 即将被调用时，就会被调用。 回调接收一个对象， 其包含被调用 action的所有相关信息：

• store: 被调用的 store
• name: action 的名称
• args: 传递给 action 的参数

在这些之上，它接收两个函数， 允许在 action 完成或失败时设置回调。

它还会返回一个函数来删除回调。 请注意，当在组件内调用 store.$onAction() 时，除非 detached 被设置为 true， 否则当组件被卸载时，它将被自动清理掉。

example

store.$onAction(({ after, onError }) => {
  // 在这里，你可以在所有的钩子之间共享变量，
  // 同时设置 watcher 和清理它们。
 after((resolvedValue) => {
   // 可以用来清理副作用 
   // `resolvedValue` 是 action 返回的值，
   // 如果是一个 Promise，它将是已解决的值
 })
 onError((error) => {
   // 可以用于向上传递错误
 })
})

返回值 #

void

function that removes the watcher

定义于 #

pinia/src/types.ts:415

$patch #

▸ $patch(partialState): void

将一个 state 补丁应用于当前状态。允许传递嵌套值

参数 #

返回值 #

void

定义于 #

pinia/src/types.ts:344

▸ $patch<F>(stateMutator): void

将多个变化分组到一个函数中。 当 mutation 对象（如 Sets 或数组）或者应用对象补丁不实用时很有用，例如追加到数组中。 传递给 $patch() 的函数必须是同步的。

类型参数 #

参数 #

返回值 #

void

定义于 #

pinia/src/types.ts:353

$reset #

▸ $reset(): void

通过建立一个新的状态对象，将 store 重设为初始状态。 TODO: make this options only

返回值 #

void

定义于 #

pinia/src/types.ts:362

$subscribe #

▸ $subscribe(callback, options?): () => void

设置一个回调，当状态发生变化时被调用。它还会返回一个函数来移除回调。 请注意，当在组件内调用 store.$subscribe() 时，除非 detached 被设置为 true， 否则当组件被卸载时，它将被自动清理掉。

参数 #

返回值 #

fn

删除 watcher 的函数

▸ (): void

设置一个回调，当状态发生变化时被调用。它还会返回一个函数来移除回调。 请注意，当在组件内调用 store.$subscribe() 时，除非 detached 被设置为 true， 否则当组件被卸载时，它将被自动清理掉。

返回值 #

void

function that removes the watcher

定义于 #

pinia/src/types.ts:374