@cinder-studio/quick-firestore

Google supplied firestore libraries are slow. This is a fast one.

Showing:

Popularity

Downloads/wk

29

GitHub Stars

7

Maintenance

Last Commit

2mos ago

Contributors

2

Package

Dependencies

4

License

MIT

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Readme

QuickFirestore

This is a pre-protection release the documentation is not yet complete. If you would like to contribute please contact us on github.

Background

Google's firestore library is super slow at warming up fresh instances. Up to 5 seconds. As documented here: https://github.com/ryanhornberger/firebase-functions-cold-start-bug .

We needed to be faster. This library takes advantage of Google's Firestore Rest API and requires no additional warmup time.

Implementation

MIT Licensed, Typescript, Minimal Dependencies (Axios is the largest), Builds to es6, Jest for unit testing.

Basic Usage

const QuickFs = new QuickFirestore({
    firestore: {
        projectName:'mockProjectYx',
        jwt: {
            clientEmail:'',
            privateKeyId:'',
            privateKey:'',
        }
    }
})

const result = await QuickFs.query(
    QuickQuery
    .collection('mockCollectionUwe')
    .select( 'email', 'name' )
    .limit(2)
    .prepare()
)

It is broken into 3 libraries of value:

QuickQuery

Build queries that can be communicated to the firebase REST api.

Documentation incomplete.

QuickFirestore

Communicate with Firestore over Rest API's with a little defensive protection.

Documentation incomplete.

FirestoreOverRest

Communicate with Firestore over Rest API's with no protection at all.

Documentation incomplete.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100