firex-store

firex-store

• If you use this npm, you can read and write firestore data, easily.
• It is inspired by vuexfire
• You can read or write firestore data, the following code, if you use this package.

import { to, from, on, firestoreMutations } from 'firex-store'
import { firestore } from '~/plugins/firebase'

// Vuex module
export default {
  state: {
    comments: []
  },
  mutations: {
    ...firestoreMutations('collection'),
    // ...firestoreMutations('all')
  },
  actions: {
    subscribe: ({ state, commit }) => {
      const ref = firestore.collection('comments')
      from(ref)
        .bindTo('comments')
        .subscribe(state, commit, /* { mapper, errorHandler, complectionHandler, afterMutationCalled } */)
    },
    unsubscribe: ({ state }) => {
      on('comments').unsubscribe(state)
    },
    find: async (_, { commentId }) => {
      const ref = firestore.collection('comments').doc('commentId')
      result = await from(ref).once().find(/* { mapper, errorHandler, completionHandler } */)
      return result
    },
    add: (_, { data }) => {
      const ref = firestore.collection('comments')
      return to(ref).add(data, /* { mapper, errorHandler, completionHandler } */)
    },
    set: (_, { data, commentId }) => {
      const ref = firestore.collection('comments').doc('commentId')
      return to(ref)
        // .transaction()  <- comment out if you use transaction
        .set(data, /* { mapper, errorHandler, completionHandler } */)
    },
    mergeSet: (_, { data, commentId }) => {
      const ref = firestore.collection('comments').doc('commentId')
      return to(ref)
        // .transaction()  <- comment out if you use transaction
        .mergeSet(data, /* { mapper, errorHandler, completionHandler } */)
    },
    delete: (_) => {
      const ref = firestore.collection('comments').doc('commentId')
      return to(ref)
      // .transaction()  <- comment out if you use transaction
        .delete(/* { errorHandler, completionHandler } */)
    }
  }
}

Installation

npm install --save firex-store

Example

• firex-store-sample

others comming soon

Important

• Return values or state values bound to Firestore has docId(documentId in Firestore) property.

• A store module cannot subscribe to more than one 'collection' and 'document'

• If you'd like to subscribe again after unsubscribing 'collection', set the property of the store you'd like to subscribe to [] and then subscribe.

Usage

• If you'd like to know more, see here, please

Difference from v0

• If you'd like to know more, see here, please

v0 Usage

• If you'd like to know more, see here, please