Interface SetupStoreDefinition<Id, SS>

Return type of defineStore() with a setup function.

Id is a string literal of the store's name
SS is the return type of the setup function

See

StoreDefinition

interface SetupStoreDefinition<Id, SS> {
$id: Id;
(pinia?, hot?): Store<Id, _ExtractStateFromSetupStore<SS>, _ExtractGettersFromSetupStore<SS>, _ExtractActionsFromSetupStore<SS>>;
}

Type Parameters

Id extends string
SS

Hierarchy (view full)

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

SetupStoreDefinition(pinia?, hot?): Store<Id, _ExtractStateFromSetupStore<SS>, _ExtractGettersFromSetupStore<SS>, _ExtractActionsFromSetupStore<SS>>
Returns a store, creates it if necessary.
Parameters
- Optional pinia: Pinia
  Pinia instance to retrieve the store
- Optional hot: StoreGeneric
  dev only hot module replacement
Returns Store<Id, _ExtractStateFromSetupStore<SS>, _ExtractGettersFromSetupStore<SS>, _ExtractActionsFromSetupStore<SS>>
- Defined in node_modules/pinia/dist/pinia.d.ts:596

Index

Properties

Properties

$id

$id: Id

Id of the store. Used by map helpers.

Generated using TypeDoc