Mycure Vue Notifs module

Installation and Usage

$ yarn add @mycure/notifs

• use as a vue plugin

import Vue from 'vue';
import McNotifs from '@mycure/notifs';

Vue.use(McNotifs, opts: ServiceOpts)

• above will do the ff:
  • describe side effects here
  • sample side effects:
    • attach a global method/attribute
    • attach an instance method/attribute
    • add components
    • sync a single and multi vuex store modules

  interface StoreOpts {
    moduleName: string = 'notifs',
    multi: boolean = true    // ataches a multi item vuex store module
    single: boolean = true   // ataches a single item vuex store module
  }

  interface ServiceOpts {
    // will be used to auto-generate query functions
    firebaseApp?: firebase.App
    URL_NOTIFS: string = '/v3/notifications'
    notificationsOf: (URL_NOTIFS) => (user) => string
    detailsOfNotification: (URL_NOTIFS) => (notifId, user) => string
    // for registering built-in store modules
    store: VuexStore
    storeOpts?: StoreOpts
    // and other valid SingleItemSyncService and MultiItemSyncService configs, see @topsi/services docus
  }

VuexStoreModules

SingleItemStoreModule

vuexModuleName = 'notifs-single'
interface RegisteredVuexModule extends RegisteredSingleItemStoreModule { // see @topsi/services docus for its RegisteredSingleItemStoreModule
}

MultiItemStoreModule

vuexModuleName = 'notifs-multi'
interface RegisteredVuexModule extends RegisteredMultiItemStoreModule {  // see @topsi/services docus for its RegisteredMultiItemStoreModule
}