:warning: This fork was created to implement support for other databases in Firebase. The original project can be found here. If the original project ever implements support for other databases, this fork will be archived. I do not intend to maintain this fork either.

In the meantime, you can find it on npm here.

🎉️ NEW: Typesaurus X is out!

🦕 Typesaurus

TypeScript-first ODM for Firestore.

Looking for React adaptor? Check Typesaurus React!

Why?

• Designed with TypeScript's type inference in mind
• Universal code (browser & Node.js)
• Uncompromised type-safety
• Code autocomplete
• Say goodbye to any!
• Say goodbye to exceptions!
• Ready to start? Follow this guide.

Installation

The library is available as an npm package. To install Typesaurus, run:

npm install --save npm i typesaurus-multi-db-support firebase firebase-admin

Note that Typesaurus requires the firebase package to work in the web environment and firebase-admin to work in Node.js. These packages aren't listed as dependencies, so they won't install automatically with the Typesaurus package.

Features

• Complete type-safety: uncompromised type-safety, includes Firestore quirks.
• Universal package: reuse the same code on the client and server.
• JavaScript-native: converts Firestore data types, i.e. timestamp, to native JS types, i.e. Date.
• Build size-efficiency: optimized build-size for web.
• Typed ids: all document ids are types, so you'll never mix up a user id with an account id.
• Centralized schema: easy to define, read and update.
• Single-import principle: single import to define, single import to use.

Changelog

See the changelog.

License

MIT © Sasha Koss