API Reference
Complete API documentation for all Zero Sources libraries and packages
Available APIs
@cbnsndwch/zero-contracts
Protocol types and interfaces (57 APIs)
@cbnsndwch/zero-source-mongodb
MongoDB change source API (41 APIs)
@cbnsndwch/zero-nest-mongoose
NestJS Mongoose integration API (20 APIs)
@cbnsndwch/zero-watermark-zqlite
ZQLite watermark storage API (12 APIs)
@cbnsndwch/zero-watermark-nats-kv
NATS KV watermark storage API (12 APIs)
@cbnsndwch/zero-nest-synced-queries
NestJS synced queries API (155 APIs)
@cbnsndwch/zrocket-contracts
ZRocket application contracts API (57 APIs)
API Documentation Format
API documentation includes:
- Classes: Constructor, methods, properties
- Interfaces: Type definitions and contracts
- Functions: Parameters, return types, examples
- Types: TypeScript type aliases and unions
- Examples: Usage examples for each API
TypeScript Support
All APIs provide full TypeScript support with:
- Complete type definitions
- JSDoc comments
- IDE autocomplete
- Type inference
Generating API Docs
API documentation is automatically generated from source code using Microsoft API Extractor:
# Generate all API docs
pnpm build:api-docsFor more information on maintaining API documentation, see the API Documentation Guide.
Contributing
Help improve API documentation:
- Add JSDoc comments to public APIs
- Include usage examples
- Document edge cases
- Update when APIs change
How was this page?