JSPM

firelordjs

2.1.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 204
  • Score
    100M100P100Q82777F
  • License MIT

🔥 Extremely High Precision Typescript Wrapper for Firestore Web, Providing Unparalleled Type Safe and Dev Experience

Package Exports

  • firelordjs
  • firelordjs/dist/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 (firelordjs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

FirelordJS 烈火君JS

Created by tylim88   License   dependency count   package size   github action   code coverage   GitHub issues   code coverage   Total alerts   Language grade: JavaScript

Extremely High Precision Typescript Wrapper for Firestore Web, Providing Unparalleled Type Safe and Dev Experience

Modular, Minuscule, Intuitive, Unopinionated, Craftsmanship, Ultimate, Peaceful, Deep

Of The VFQAT   ||   By The VFQAT   ||   For The VFQAT

End Firestore Typing Madness


FirelordJS is the only library that capable of providing insane type safety while exposing almost all the API of the original Firestore SDK.

FirelordJS has:

  • The lowest learning curve (API is nearly identical to the original API).
  • The lowest technical debt (easiest to revert to the original API).
  • The best type safety**.
  • The only library capable of typing against Firestore limitations.
  • Effortless solutions for Firestore quirks.
  • Possibly also the smallest.

It is what you are looking at: the Master of Fire.

Support @firebase/rules-unit-testing and emulator

In CI We test:

  • Development code: check logic correctness
  • Built code: check compiler setting
  • Published code: check package.json entry point

** I am confident it has the best type safe and nothing come close to it and I put money on my words. I will buy you x cups of coffee if you:

  1. found something better: 75 cups
  2. created something better: 1000 cups (you don't need to a make full fledge library, something that is minimally better is enough, open an issue if you want to take this challenge)

Trivial

  • The name Firelord is a reference to the Firelord of Avatar.
  • For learning purposes, don't clone this project. Instead, you should clone its sister project, FireSageJS. FireSageJS is harder to code but less quirky, which means FireSageJS utilises more Typescripts techniques and is less trivial. FireSageJS was created after FirelordJS, so FireSageJS is much better at code organization and basically everything else. These factors make FireSageJS a much more ideal learning material than FirelordJS.

Contributing

Read here

  1. Firelord - Typescript wrapper for Firestore Admin
  2. FirelordRN - Typescript wrapper for Firestore React Native
  3. FireLaw - Write Firestore security rule with Typescript, utilizing Firelord type engine.
  4. FireCall - Helper Function to write easier and safer Firebase onCall function.
  5. FireSageJS - Typescript wrapper for Realtime Database