Package Exports
- @firebase/firestore
- @firebase/firestore/dist/cjs/index.js
- @firebase/firestore/dist/esm/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@firebase/firestore) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@firebase/firestore
This is the Cloud Firestore component for the Firebase JS SDK. It has a peer
dependency on the @firebase/app
package on NPM. This package
is not included by default in the firebase
wrapper package.
Installation
You can install this package by running the following in your project:
$ npm install @firebase/firestore
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.