Home > @xoram/plugin-panoramique > StoreAsService

StoreAsService type

Turn a Pinia `store` into a xoram `Service`.

Signature:

export type StoreAsService<store, notifications extends Record<string, unknown> = Record<string, unknown>, storeId extends string = string> = (store extends Store ? store : Store<storeId, _ExtractStateFromSetupStore<store>, _ExtractGettersFromSetupStore<store>, _ExtractActionsFromSetupStore<store>>) & Service<notifications>;

References: _ExtractStateFromSetupStore, _ExtractGettersFromSetupStore, _ExtractActionsFromSetupStore, Service

Example 1

// using an inferred store
export const useBlog = defineStore('blog', () => {
  // blog store setup
});
defineService<StoreAsService<ReturnType<typeof useBlog>>(() => useBlog())

Example 2

// using a typed store
export interface BlogStore {
  // blog store API
}
export const useBlog = defineStore<'blog', BlogStore>('blog', () => {
  // blog store setup
});
defineService<StoreAsService<BlogStore>(() => useBlog())