https://github.com/tylim88/firelord

🔥 Write V9 like Firestore Admin code with extreme type safety.
https://github.com/tylim88/firelord

firebase firestore scalable typescript

Last synced: 19 days ago
JSON representation

🔥 Write V9 like Firestore Admin code with extreme type safety.

• Host: GitHub
• URL: https://github.com/tylim88/firelord
• Owner: tylim88
• License: mit
• Created: 2021-10-14T22:32:44.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-09T06:57:17.000Z (2 months ago)
• Last Synced: 2024-10-10T03:06:01.690Z (about 1 month ago)
• Topics: firebase, firestore, scalable, typescript
• Language: TypeScript
• Homepage:
• Size: 2.97 MB
• Stars: 40
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




		

		
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](https://firelordjs.com/firelord/tests)

# 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](https://github.com/tylim88/FirelordJS#readme).

## 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](https://github.com/tylim88/FirelordJS/discussions)

Note: FirelordJS and Firelord share the same discussion space.

[release note](https://github.com/tylim88/Firelord/releases)

## Contributing

Read [here](https://firelordjs.com/miscellaneous/contributing)

## Related Projects

1. [FirelordJS](https://github.com/tylim88/FirelordJS) - Typescript wrapper for Firestore Web

2. [FireSword](https://github.com/tylim88/firesword) - Filter Firestore and RTDB Unknown Keys.

3. [FireCall](https://github.com/tylim88/FireCall) - Helper Function to write easier and safer Firebase onCall function.

4. [FireSageJS](https://github.com/tylim88/FireSageJS) - Typescript wrapper for Realtime Database