tht-firebase-api-wrappers v1.0.30

tht-firebase-api-wrappers

Common buttons used throughout the THT projects

Getting Started

Install the library with either Yarn:

yarn add tht-firebase-api-wrappers

or npm:

npm install --save tht-firebase-api-wrappers

Usage

Please note that each method will return an object of:

Exposed Methods

createDocument

Example

import {createDocument} from 'tht-firebase-api-wrappers';

function createTask(path, documentId, data) {
    createDocument(path, documentId, data)
      .then(insertionAttempt => {
        console.log(`Successfully inserted at path (${path}`);
      })
      .catch(error => {
        console.log(`Error inserting document at path (${path}) with error (${error})`);
      })
};

getAllDocumentsWithPath

Example

import {getAllDocumentsWithPath} from 'tht-firebase-api-wrappers';

function getTasks(path) {
    getAllDocumentsWithPath(path)
      .then(retrievalAttempt => {
        console.log(": ", retrievalAttempt);
      })
      .catch(error => {
        console.log(`Error retrieving documents at path (${path}) with error (${error})`);
      });
};

getDocumentsWithCriteria

Example

import {getDocumentsWithCriteria} from 'tht-firebase-api-wrappers';

function getTasksFromToday() {
    getDocumentsWithCriteria('path/to/tasks', 'createdDate', '>=', Date.now())
      .then(retrievalAttempt => {
        console.log(": ", retrievalAttempt);
      })
      .catch(error => {
        console.log(`Error retrieving documents at path (${path}) with error (${error})`);
      });
};