|
||
---|---|---|
.. | ||
dist | ||
memory | ||
CHANGELOG.md | ||
README.md | ||
package.json |
README.md
@firebase/firestore
This is the Cloud Firestore component of the Firebase JS SDK.
This package is not intended for direct usage, and should only be used via the officially supported firebase package.
If you are developing a Node.js application that requires administrative access to Cloud Firestore,
use the @google-cloud/firestore
Server
SDK with your developer credentials.
Usage
You can then use the firebase namespace exposed by this package as illustrated below:
ES Modules
import firebase from '@firebase/app';
import '@firebase/firestore'
// Do stuff w/ `firebase` and `firebase.firestore`
CommonJS Modules
const firebase = require('@firebase/app').default;
require('@firebase/firestore');
// Do stuff with `firebase` and `firebase.firestore`
Documentation
For comprehensive documentation please see the Firebase Reference Docs.
Contributing
See Contributing to the Firebase SDK for general information about contributing to the firebase-js-sdk repo and Contributing to the Cloud Firestore Component for details specific to the Cloud Firestore code and tests.