Skip to content

@pinia/root / pinia / StoreDefinition

StoreDefinition()<Id, S, G, A>

Return type of defineStore(). Function that allows instantiating a store.

Extended by

Type Parameters

Id

Id extends string = string

S

S extends StateTree = StateTree

G

G = _GettersTree<S>

A

A = _ActionsTree

ts
StoreDefinition(pinia?, hot?): Store<Id, S, G, A>;

Returns a store, creates it if necessary.

Parameters

pinia?

Pinia instance to retrieve the store

Pinia | null

hot?

StoreGeneric

dev only hot module replacement

Returns

Store<Id, S, G, A>

Properties

$id

ts
$id: Id;

Id of the store. Used by map helpers.

Released under the MIT License.