Nonviolent Pirate Mobster
Unleash awesomeness. Private packages, team management tools, and powerful integrations. Get started with npm Orgs »

@mycure/es-search

0.1.0 • Public • Published

js-semistandard-style

Mycure Vue Es-search module

Installation and Usage

$ yarn add @mycure/es-search
  • use as a vue plugin
import Vue from 'vue';
import McEs-search from '@mycure/es-search';
 
Vue.use(McEs-search, 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 = 'es-search',
    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
    authService?: AuthService
    // for registering built-in store modules
    store: VuexStore
    storeOpts?: StoreOpts
    // and other valid SingleItemSyncService and MultiItemSyncService configs, see @topsi/services docus
  }

VuexStoreModules

SingleItemStoreModule

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

MultiItemStoreModule

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

Keywords

install

npm i @mycure/es-search

Downloadsweekly downloads

0

version

0.1.0

license

ISC

repository

Gitbitbucket

last publish

collaborators

    Report a vulnerability