README.md

Instant Firestore

Firebase Cloud Firestore ORM to ease common tasks such as creating, finding, updating and deleting documents.

Please note: This is an unofficial Firestore package, part of the instant suite of tools.

Table of Contents

• Installation
• Usage
• API
  • create
  • createMany
  • find
  • findOne
  • findById
  • createWithId
  • update
  • delete
  • updateOrCreate
• Contributing
• License

Installation

You can install this package using npm:

$ npm install instant-firestore

Usage

Here is a quick example to get you started:

ES Modules

import { FirestoreRepository } from 'instant-firestore';

// Pass your firestore instance and a collection reference to the constructor
const fr = new FirestoreRepository(db, db.collection('your-collection-name'));

const data await = fr.findById('12345');
console.log(data);

CommonJS Modules

var FirestoreRepository = require('instant-firestore').FirestoreRepository;

// Pass your firestore instance and a collection reference to the constructor
var fr = new FirestoreRepository(db, db.collection('your-collection-name'));

fr.findById('12345').then(function(data) {
  console.log(data);
});

API

create

Create a Firestore document.

Arguments

attributes (Object): The document attributes.
options (Object): Options.

Returns

(Object): The serialized document

createMany

find

findOne

findById

createWithId

update

delete

updateOrCreate

Contributing

We'd greatly appreciate any contribution you make.

License

MIT