Cosmoose

Class: Cosmoose

The main entry point for connecting to Azure Cosmos DB and registering models. Extends EventEmitter.

index.ts

import { Cosmoose } from '@cosmoose/core';

Signature

new Cosmoose(options: CosmooseOptions)

Property	Type	Description
`endpoint`	`string`	Cosmos DB account endpoint URL
`key`	`string`	Primary or secondary access key
`databaseName`	`string`	Database name (created if it doesn't exist)

Signature

async connect(): Promise<void>

Connects to the database and creates it if it doesn't exist.

Safe to call multiple times — subsequent calls are no-ops.

Signature

model<T>(name: string, schema: Schema<T>): Model<T>

Registers a model for the given container name. Must be called after connect().

Parameter	Type	Description
`name`	`string`	Container name in Cosmos DB
`schema`	`Schema<T>`	Schema defining document shape

Returns: Model<T>

Throws: Error if not connected or if model name is already registered.

Signature

async syncContainers(): Promise<SyncReport>

Syncs all registered model containers. Creates missing containers, updates mutable properties, and reports drift for immutable properties.

Returns: SyncReport (array of ContainerSyncResult)

Signature

async syncContainer(name: string): Promise<ContainerSyncResult>

Syncs a single container by name.

Signature

isConnected(): boolean

Returns true if connected to the database.

Signature

getDatabase(): Database | undefined

Returns the underlying @azure/cosmos Database instance, or undefined if not connected.

Signature

getRegisteredModels(): Map<string, RegisteredModel>

Returns all registered models.

Event	Payload	When
`initiate`	—	Before connection starts
`initiated`	`databaseName: string`	After successful connection