跳至内容

API 文档文档


API 文档 / pinia / mapWritableState

函数: mapWritableState()

允许在不使用组合式 API (setup()) 的情况下使用一个 store 中的状态和 getter,通过生成一个对象来在组件的 computed 字段中展开。

参数

要映射的 store

参数

数组或对象

mapWritableState(useStore, keyMapper)

mapWritableState<Id, S, G, A, KeyMapper>(useStore, keyMapper): _MapWritableStateObjectReturn<S, KeyMapper>

mapState() 相同,但也会创建计算 setter,以便可以修改状态。与 mapState() 不同的是,只能添加 state 属性。

类型参数

Id extends string

S extends StateTree

G extends _GettersTree<S>

A

KeyMapper extends Record<string, keyof S>

参数

useStore: StoreDefinition<Id, S, G, A>

要映射的 store

keyMapper: KeyMapper

状态属性对象

返回值

_MapWritableStateObjectReturn<S, KeyMapper>

mapWritableState(useStore, keys)

mapWritableState<Id, S, G, A, Keys>(useStore, keys): { [K in Keys]: Object }

允许在不使用组合式 API (setup()) 的情况下使用一个 store 中的状态和 getter,通过生成一个对象来在组件的 computed 字段中展开。

类型参数

Id extends string

S extends StateTree

G extends _GettersTree<S>

A

Keys extends string | number | symbol

参数

useStore: StoreDefinition<Id, S, G, A>

要映射的 store

keys: readonly Keys[]

状态属性数组

返回值

{ [K in Keys]: Object }