1.0.30 • Published 4 years ago

tht-firebase-api-wrappers v1.0.30

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

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:

PropertyTypeDescription
pathstringCollection within Firebase to create document
idstringThe id of the new/updated document if single or undefined if multiple documents were affected
dataobjList of the document(s) being operated on
errorstring, undefinedundefined if no error has occurred

Exposed Methods

createDocument

PropertyRequiredTypeDescription
pathtruestringCollection within Firebase to create document
documentIdtruestringThe id that will be assigned to newly created document
datatrueobjThe 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

PropertyRequiredTypeDescription
pathtruestringCollection 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

PropertyRequiredTypeDescription
pathtruestringCollection within Firebase to create document
fieldtruestringThe field to compare against
pathtrueWhereFilterOpFilter for the operation
criteriatrueanyThe 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})`);
      });
};
1.0.30

4 years ago

1.0.29

4 years ago

1.0.28

4 years ago

1.0.27

4 years ago

1.0.26

4 years ago

1.0.25

4 years ago

1.0.24

4 years ago

1.0.23

4 years ago

1.0.22

4 years ago

1.0.21

4 years ago

1.0.2

4 years ago

1.0.19

4 years ago

1.0.18

4 years ago

1.0.17

4 years ago

1.0.16

4 years ago

1.0.15

4 years ago

1.0.14

4 years ago

1.0.13

4 years ago

1.0.12

4 years ago

1.0.11

4 years ago

1.0.1

4 years ago