API 文档 • 文档

---

API 文档 / pinia / defineStore

函数: defineStore()

defineStore(id, options)

defineStore<Id, S, G, A>(id, options): StoreDefinition<Id, S, G, A>

创建一个 useStore 函数，用于检索存储实例

类型参数

• Id extends string

• S extends StateTree = object

• G extends _GettersTree<S> = object

• A = object

参数

• id: Id

存储的 ID（必须唯一）

• options: Omit<DefineStoreOptions<Id, S, G, A>, "id">

定义存储的选项

返回

StoreDefinition<Id, S, G, A>

defineStore(options)

defineStore<Id, S, G, A>(options): StoreDefinition<Id, S, G, A>

创建一个 useStore 函数，用于检索存储实例

类型参数

• Id extends string

• S extends StateTree = object

• G extends _GettersTree<S> = object

• A = object

参数

• options: DefineStoreOptions<Id, S, G, A>

定义存储的选项

返回

StoreDefinition<Id, S, G, A>

defineStore(id, storeSetup, options)

defineStore<Id, SS>(id, storeSetup, options?): StoreDefinition<Id, _ExtractStateFromSetupStore<SS>, _ExtractGettersFromSetupStore<SS>, _ExtractActionsFromSetupStore<SS>>

创建一个 useStore 函数，用于检索存储实例

类型参数

• Id extends string

• SS

参数

• id: Id

存储的 ID（必须唯一）

• storeSetup

定义存储的函数

• options?: DefineSetupStoreOptions<Id, _ExtractStateFromSetupStore<SS>, _ExtractGettersFromSetupStore<SS>, _ExtractActionsFromSetupStore<SS>>

额外的选项

返回

StoreDefinition<Id, _ExtractStateFromSetupStore<SS>, _ExtractGettersFromSetupStore<SS>, _ExtractActionsFromSetupStore<SS>>