@fireschema/ts-runtime
This package provides the runtime library for TypeScript code generated by the
FireSchema tool. It contains the base
classes and utilities necessary for the generated Object Document Mapper (ODM)
code to interact with Google Firestore.
Installation
You typically don't install this package directly. It will be added as a
dependency by the fireschema tool when generating TypeScript code.
However, if you need to install it manually:
npm install @fireschema/ts-runtime firebase
yarn add @fireschema/ts-runtime firebase
pnpm add @fireschema/ts-runtime firebase
Note: This package requires firebase (version 9, 10, or 11) as a peer
dependency.
Usage
This package is intended for internal use by the code generated by fireschema.
The generated classes (e.g., UsersCollection, UsersQueryBuilder,
UsersUpdateBuilder) extend the base classes provided by this runtime
(BaseCollectionRef, BaseQueryBuilder, BaseUpdateBuilder).
Refer to the main
FireSchema documentation for details
on how to use the generated code.
Contributing
Please refer to the main
FireSchema repository for contribution
guidelines.
License
MIT