Getting started ​

Fireman is a simple, yet powerful, wrapper around the firestore SDK providing firestore helper functions. (soon the firestore admin sdk too). It provides a simple interface to get, update and delete data from your firestore instance.

Installation ​

If you are using Firebase on the browser ​

npm install @fireman/web

If you are using Firebase on the server (nodejs) ​

npm install @fireman/admin

Initializing Firestore ​

Fireman needs to access your firestore instance. You can do this by passing the firestore instance as a parameter to the fireman function.

import { initializeApp } from "firebase/app";
import { getFirestore } from "firebase/firestore";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
const app = initializeApp(firebaseConfig);


// Initialize Cloud Firestore and get a reference to the service, you should export it in case you need to access it elsewhere.
export const db = getFirestore(app);

You may follow instructions on the Firebase docs to initialize Firestore

Initializing Fireman ​

A Fireman instance is initialized using the previously initialized Firestore instance.

import Fireman from "@fireman/web/firestore" // or @fireman/admin

export const fireman = new Fireman(db);

You can then import it and use it anywhere throughout your code as specified in the usage guide.

More ​

Fireman returns data from the get function with an added id property by default. This property references the documentId of the returned data

fireman.get("users", "userId").then(user => {
  console.log(user.id); // userId
});

You may want to edit this behaviour by instantiating the Fireman instance with a fieldId property containing the desired name of the property.

// this will change the fieldId from "id" to "__id__"
// on all documents returned from Fireman

export const fireman = new Fireman(db, "__id__");