1.0.3 • Published 5 years ago

instant-firestore-utils v1.0.3

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

Instant Firestore Utils

Lightweight Firebase Firestore utility library.

Please note: Although this package can be utilized with raw Firestore Documents and Collections, it may be easier to use the instant-firestore ORM depending on your requirements.

Table of Contents

Installation

You can install this package using npm:

$ npm install instant-firestore-utils

Usage

Here is a quick example to get you started:

ES Modules

import { getDocument } from 'instant-firestore-utils';

const test = async () => {
  const doc = await getDocument(db.collection('countries')); // Assumes db is a Firebase Firestore reference
  console.log(doc);
};

CommonJS Modules

var getDocument = require('instant-firestore-utils').getDocument;

getDocument(db.collection('countries')).then(function(doc) {
  console.log(doc);
});

API

getDocument

getCollection

getSubCollection

serializeDocument

serializeSnapshot

populate

populateReference

populatePath

populateSubcollection

deserialize

deserializePath

Contributing

We'd greatly appreciate any contribution you make.

License

MIT

1.0.3

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago

0.0.6

6 years ago

0.0.5

6 years ago

0.0.4

6 years ago

0.0.3

6 years ago

0.0.2

6 years ago

0.0.1

6 years ago