firesearch v0.0.14

FireSearch

FireSearch is a JavaScript package built to easily support text searches in firestore database. Built by EmbyBest Concept to assist firebase/firestore developers to search through their data content stored in firestore. It is tested with Node.js and can easily be adapted to other JavaScript-based environments as well.

Installation

Install FireSearch via npm by running the following command:

npm install firesearch --save

Usage

Create an instance of FireSearch and call available methods from the instance created.

import { FireSearch } from 'firesearch';

const fireSearch = new FireSearch();

Use FireSearch utilities functions as follows

// converts all timestamp in doc to js date
const doc = {
  a: {},
  b: {}
};

console.log(doc);

Methods

NB:

This package is an easy go-to solution to support simple text search queries in a typical firestore database. Following are some noted limitations of firesearch: 1. Does not support sorting, ordering in firestore queries 2. Only supports indexing of JavaScript values that can easily be converted to string. Examples, Date.toString(), Number.toString() etc