Skip to main content
API Reference / modelence / server / Store Defined in: src/data/store.ts:52 The Store class provides a type-safe interface for MongoDB collections with built-in schema validation and helper methods.

​
Example

const dbTodos = new Store('todos', {
  schema: {
    title: schema.string(),
    completed: schema.boolean(),
    dueDate: schema.date().optional(),
    userId: schema.userId(),
  },
  methods: {
    isOverdue() {
      return this.dueDate < new Date();
    }
  }
});

​
Type Parameters

Type ParameterDescription
TSchema extends ModelSchemaThe document schema type
TMethods extends Record<string, (this, …args) => any>Custom methods that will be added to documents

​
Constructors

​
Constructor

new Store<TSchema, TMethods>(name, options): Store<TSchema, TMethods>
Defined in: src/data/store.ts:79 Creates a new Store instance

​
Parameters

ParameterTypeDescription
namestringThe collection name in MongoDB
options{ indexes: IndexDescription[]; methods?: TMethods; schema: TSchema; searchIndexes?: SearchIndexDescription[]; }Store configuration
options.indexesIndexDescription[]MongoDB indexes to create
options.methods?TMethodsCustom methods to add to documents
options.schemaTSchemaDocument schema using Modelence schema types
options.searchIndexes?SearchIndexDescription[]MongoDB Atlas Search

​
Returns

Store<TSchema, TMethods>

​
Properties

PropertyModifierTypeDefined in
DocreadonlyEnhancedOmit<InferDocumentType<TSchema>, "_id"> & object & TMethodssrc/data/store.ts:63

​
Methods

​
aggregate()

aggregate(pipeline, options?): AggregationCursor<Document>
Defined in: src/data/store.ts:377 Aggregates documents using MongoDB’s aggregation framework

​
Parameters

ParameterTypeDescription
pipelineDocument[]The aggregation pipeline
options?AggregateOptionsOptional options

​
Returns

AggregationCursor<Document> The aggregation cursor

​
bulkWrite()

bulkWrite(operations): Promise<BulkWriteResult>
Defined in: src/data/store.ts:387 Performs a bulk write operation on the collection

​
Parameters

ParameterTypeDescription
operationsAnyBulkWriteOperation<InferDocumentType<TSchema>>[]The operations to perform

​
Returns

Promise<BulkWriteResult> The result of the bulk write operation

​
countDocuments()

countDocuments(query): Promise<number>
Defined in: src/data/store.ts:266 Counts the number of documents that match a query

​
Parameters

ParameterTypeDescription
queryFilter<InferDocumentType<TSchema>>The query to filter documents

​
Returns

Promise<number> The number of documents that match the query

​
deleteMany()

deleteMany(selector): Promise<DeleteResult>
Defined in: src/data/store.ts:366 Deletes multiple documents

​
Parameters

ParameterTypeDescription
selectorFilter<InferDocumentType<TSchema>>The selector to find the documents to delete

​
Returns

Promise<DeleteResult> The result of the delete operation

​
deleteOne()

deleteOne(selector): Promise<DeleteResult>
Defined in: src/data/store.ts:356 Deletes a single document

​
Parameters

ParameterTypeDescription
selectorFilter<InferDocumentType<TSchema>>The selector to find the document to delete

​
Returns

Promise<DeleteResult> The result of the delete operation

​
fetch()

fetch(query, options?): Promise<EnhancedOmit<InferDocumentType<TSchema>, "_id"> & object & TMethods[]>
Defined in: src/data/store.ts:277 Fetches multiple documents, equivalent to Node.js MongoDB driver’s find and toArray methods combined.

​
Parameters

ParameterTypeDescription
queryFilter<InferDocumentType<TSchema>>The query to filter documents
options?{ limit?: number; skip?: number; sort?: Document; }Options
options.limit?number-
options.skip?number-
options.sort?Document-

​
Returns

Promise<EnhancedOmit<InferDocumentType<TSchema>, "_id"> & object & TMethods[]> The documents

​
findById()

findById(id): Promise<null | EnhancedOmit<InferDocumentType<TSchema>, "_id"> & object & TMethods>
Defined in: src/data/store.ts:240 Fetches a single document by its ID

​
Parameters

ParameterTypeDescription
idstring | ObjectIdThe ID of the document to find

​
Returns

Promise<null | EnhancedOmit<InferDocumentType<TSchema>, "_id"> & object & TMethods> The document, or null if not found

​
findOne()

findOne(query, options?): Promise<null | EnhancedOmit<InferDocumentType<TSchema>, "_id"> & object & TMethods>
Defined in: src/data/store.ts:199

​
Parameters

ParameterType
queryFilter<InferDocumentType<TSchema>>
options?FindOptions<Document>

​
Returns

Promise<null | EnhancedOmit<InferDocumentType<TSchema>, "_id"> & object & TMethods>

​
getDatabase()

getDatabase(): Db
Defined in: src/data/store.ts:396 Returns the raw MongoDB database instance for advanced operations

​
Returns

Db The MongoDB database instance

​
Throws

Error if the store is not provisioned

​
getName()

getName(): string
Defined in: src/data/store.ts:99

​
Returns

string

​
insertMany()

insertMany(documents): Promise<InsertManyResult<Document>>
Defined in: src/data/store.ts:298 Inserts multiple documents

​
Parameters

ParameterTypeDescription
documentsOptionalUnlessRequiredId<InferDocumentType<TSchema>>[]The documents to insert

​
Returns

Promise<InsertManyResult<Document>> The result of the insert operation

​
insertOne()

insertOne(document): Promise<InsertOneResult<Document>>
Defined in: src/data/store.ts:288 Inserts a single document

​
Parameters

ParameterTypeDescription
documentOptionalUnlessRequiredId<InferDocumentType<TSchema>>The document to insert

​
Returns

Promise<InsertOneResult<Document>> The result of the insert operation

​
rawCollection()

rawCollection(): Collection<InferDocumentType<TSchema>>
Defined in: src/data/store.ts:405 Returns the raw MongoDB collection instance for advanced operations

​
Returns

Collection<InferDocumentType<TSchema>> The MongoDB collection instance

​
Throws

Error if the store is not provisioned

​
renameFrom()

renameFrom(oldName, options?): Promise<void>
Defined in: src/data/store.ts:414 Renames an existing collection to this store’s name, used for migrations

​
Parameters

ParameterTypeDescription
oldNamestringThe previous name of the collection
options?{ session?: ClientSession; }-
options.session?ClientSession-

​
Returns

Promise<void>

​
Throws

Error if the old collection doesn’t exist or if this store’s collection already exists

​
requireById()

requireById(id, errorHandler?): Promise<EnhancedOmit<InferDocumentType<TSchema>, "_id"> & object & TMethods>
Defined in: src/data/store.ts:252 Fetches a single document by its ID, or throws an error if not found

​
Parameters

ParameterTypeDescription
idstring | ObjectIdThe ID of the document to find
errorHandler?() => ErrorOptional error handler to return a custom error if the document is not found

​
Returns

Promise<EnhancedOmit<InferDocumentType<TSchema>, "_id"> & object & TMethods> The document

​
requireOne()

requireOne(query, options?, errorHandler?): Promise<EnhancedOmit<InferDocumentType<TSchema>, "_id"> & object & TMethods>
Defined in: src/data/store.ts:207

​
Parameters

ParameterType
queryFilter<InferDocumentType<TSchema>>
options?FindOptions<Document>
errorHandler?() => Error

​
Returns

Promise<EnhancedOmit<InferDocumentType<TSchema>, "_id"> & object & TMethods>

​
updateMany()

updateMany(selector, update, options?): Promise<UpdateResult<Document>>
Defined in: src/data/store.ts:331 Updates multiple documents

​
Parameters

ParameterTypeDescription
selectorFilter<InferDocumentType<TSchema>>The selector to find the documents to update
updateUpdateFilter<InferDocumentType<TSchema>>The MongoDB modifier to apply to the documents
options?{ session?: ClientSession; }-
options.session?ClientSession-

​
Returns

Promise<UpdateResult<Document>> The result of the update operation

​
updateOne()

updateOne(selector, update): Promise<UpdateResult<Document>>
Defined in: src/data/store.ts:309 Updates a single document

​
Parameters

ParameterTypeDescription
selectorstring | ObjectId | Filter<InferDocumentType<TSchema>>The selector to find the document to update
updateUpdateFilter<InferDocumentType<TSchema>>The update to apply to the document

​
Returns

Promise<UpdateResult<Document>> The result of the update operation

​
upsertMany()

upsertMany(selector, update): Promise<UpdateResult<Document>>
Defined in: src/data/store.ts:346 Updates multiple documents, or inserts them if they don’t exist

​
Parameters

ParameterTypeDescription
selectorFilter<InferDocumentType<TSchema>>The selector to find the documents to update
updateUpdateFilter<InferDocumentType<TSchema>>The MongoDB modifier to apply to the documents

​
Returns

Promise<UpdateResult<Document>> The result of the update operation

​
upsertOne()

upsertOne(selector, update): Promise<UpdateResult<Document>>
Defined in: src/data/store.ts:320 Updates a single document, or inserts it if it doesn’t exist

​
Parameters

ParameterTypeDescription
selectorstring | ObjectId | Filter<InferDocumentType<TSchema>>The selector to find the document to update
updateUpdateFilter<InferDocumentType<TSchema>>The MongoDB modifier to apply to the document

​
Returns

Promise<UpdateResult<Document>> The result of the update operation