README.md

Firelord 烈火君

           

High Precision Firestore Admin Typescript Wrapper, Providing Unparalleled Type Safety and Dev Experience

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

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

Be The Master Of Your Fire, Be Firelord

Beyond Typing

Doc

Support emulator

Notice

Because the official admin SDK is lagging behind the official web SDK, Which mean or() and and() clause are not available for admin. (update: they are available now, will add them in the future)

Why Do You Need This? What Problems Firelord Solves?

Read here at FirelordJS.

About

This wrapper wrap around admin Firestore V8 interface(There is no official V9 admin version) and turn it into type safe V9 interface.

The API is basically same as the web version, both web and admin version basically sharing the same documentation.

It does not become modular like the web version, but this is ok because we don't care about package size in back end.

The ultimate goal is to unify the knowledge of back end and front end, so we don't need to learn both V9 and V8 and most importantly: absolute type safe.

Due to a lot of small differences, it is unrealistic to squeeze both platforms under the same library unless we give up some functionalities.

What is next?

Add support for Firestore function triggers.

Have Questions?

Just Ask

Note: FirelordJS and Firelord share the same discussion space.

release note

Contributing

Read here

Related Projects

1. FirelordJS - Typescript wrapper for Firestore Web
2. FireSword - Filter Firestore and RTDB Unknown Keys.
3. FireCall - Helper Function to write easier and safer Firebase onCall function.
4. FireSageJS - Typescript wrapper for Realtime Database