Documentation overview
Topic index for @reggieofarrell/firestore-orm. New to the library? Start with
Getting Started, then browse the nested sections in the sidebar (or the tables
below).
How this is organized
Section titled “How this is organized”- Concepts — the mental model: repositories, converters, schema validation, and hooks.
- Operations — the day-to-day API: CRUD, queries, transactions, subcollections, nested updates.
- Reference — exhaustive signatures and error semantics.
- Integration & extensions — framework wiring and the optional vector-search module.
- Guidance — best practices, cost model, worked examples, patterns, and troubleshooting.
Contents
Section titled “Contents”Concepts
Section titled “Concepts”| Page | What it covers |
|---|---|
| Core Concepts | Repository pattern, Firestore converters, delete behavior |
| Schema Validation | Zod validation lifecycle, derived create/update schemas, id handling |
| Per-Field Sentinel Approval | Write combinators, sentinelPolicy: 'strict', sharing types front-end |
| Timestamps ↔ Millis | createMillisTimestampConverter and the write/read timestamp pattern |
| Lifecycle Hooks | before*/after* hooks, payloads, and ordering |
Operations
Section titled “Operations”| Page | What it covers |
|---|---|
| CRUD Operations | Create, read, update, delete, and bulk variants |
| Queries | Query builder, aggregations, streaming, real-time subscriptions |
| Transactions | runInTransaction and the transaction-scoped methods |
| Subcollections | Nested collections and per-instance converter behavior |
| Dot Notation for Nested Updates | Field-path updates, merge/patch, and FieldValue sentinels |
Reference
Section titled “Reference”| Page | What it covers |
|---|---|
| API Reference | Every FirestoreRepository / FirestoreQueryBuilder signature |
| Error Handling | Error classes, when they throw, and the Express middleware |
Integration & extensions
Section titled “Integration & extensions”| Page | What it covers |
|---|---|
| Framework Integration | Express.js and NestJS wiring |
| Firestore Triggers | Mapping trigger snapshots with fromSnapshot |
| Vector Search | The optional ./vector extension and findNearest |
Guidance
Section titled “Guidance”| Page | What it covers |
|---|---|
| Best Practices | Recommended patterns for production use |
| Performance | Firestore cost model, optimization tips, benchmarks |
| Real-World Examples | End-to-end e-commerce, multi-tenant, and social feed |
| Advanced Patterns | Audit logging, caching, event-driven, denormalization |
| Troubleshooting | Common errors and their fixes |