import { ActionTree } from 'vuex'; import { SubscribeOptionsParameter } from '../../parameters'; import { Subscriber } from '../../models'; interface OptionsParameter extends SubscribeOptionsParameter { /** * @param actionName action name registered to ActionTree */ actionName?: string; } /** * Subscribe firestore data to state property * @param firestoreSubscriber: FirestoreSubscriber instance * @param options: { * actionName, * mapper, * errorHandler, * notFoundHandler, * completionHandler * afterMutationCalled } | undefined * @returns ActionTree * * @example * import { firestoreSubscribeAction, FirestoreSubscriber, from } from 'firex-store' * actions: { * ...firestoreSubscribeAction( * FirestoreSubscriber * .from(firebase.firestore().collection('collection')) * .bindTo('statePropName'), * { actionName: 'customActionName' } * ), * ...firestoreSubscribeAction( * from(firebase.firestore().collection('collection')) * .bindTo('statePropName'), * { actionName: 'customActionName2' } * ) * } * */ export declare const firestoreSubscribeAction: (firestoreSubscriber: Subscriber, options?: OptionsParameter | undefined) => ActionTree; export {};