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:

| Property | Type | Description | |-----------|------|-------------| | path | string | Collection within Firebase to create document | | id | string | The id of the new/updated document if single or undefined if multiple documents were affected | | data | [obj] | List of the document(s) being operated on | | error | string, undefined | undefined if no error has occurred |

Exposed Methods

createDocument

| Property | Required | Type | Description | |----------|----------|------|-------------| | path | true | string | Collection within Firebase to create document | | documentId | true | string | The id that will be assigned to newly created document | | data | true | obj | The fields to store in the document being created |

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

| Property | Required | Type | Description | |----------|----------|------|-------------| | path | true | string | Collection within Firebase to create document |

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

| Property | Required | Type | Description | |----------|----------|------|-------------| | path | true | string | Collection within Firebase to create document | | field | true | string | The field to compare against | | path | true | WhereFilterOp | Filter for the operation | | criteria | true | any | The values to check for |

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})`);
      });
};