Interface MongodbModel<IdType>

constructor

• new MongodbModel(): MongodbDocument<IdType>

• Returns MongodbDocument<IdType>

Readonly $fieldsDefinitions

Readonly booted

Optional Readonly collectionName

Optional Readonly connection

$addComputed

• $addComputed(name, options): ComputedOptions

• Managing computed columns

  Parameters

  • name: string

  • options: Partial<ComputedOptions>

  Returns ComputedOptions

$addField

• $addField(name, options?): FieldOptions

• Add a field on the model. This is usually done by the @field decorator.

  Parameters

  • name: string

  • Optional options: Partial<FieldOptions>

  Returns FieldOptions

$getComputed

• $getComputed(name): undefined | ComputedOptions

• Parameters

  • name: string

  Returns undefined | ComputedOptions

$getField

• $getField(name): undefined | FieldOptions

• Returns the field options if it exists.

  Parameters

  • name: string

  Returns undefined | FieldOptions

$hasComputed

• $hasComputed(name): boolean

• Parameters

  • name: string

  Returns boolean

$hasField

• $hasField(name): boolean

• Returns whether the field exists on the model.

  Parameters

  • name: string

  Returns boolean

all

• all<ModelType>(this, options?): Promise<InstanceType<ModelType>[]>

• Fetch all documents in the collection.

  Type Parameters

  • ModelType extends MongodbModel<IdType>

  Parameters

  • this: ModelType

  • Optional options: ModelAdapterOptions<FindOptions<ModelAttributes<InstanceType<ModelType>>>>

  Returns Promise<InstanceType<ModelType>[]>

boot

• boot(): void

• Boot the model.

  Returns void

count

• count<ModelType>(this, filter, options?): Promise<number>

• Count the number of documents in the collection that match the filter.

  Type Parameters

  • ModelType extends MongodbModel<IdType>

  Parameters

  • this: ModelType

  • filter: Filter<ModelAttributes<InstanceType<ModelType>>>

  • Optional options: ModelAdapterOptions<CountDocumentsOptions>

  Returns Promise<number>

create

• create<ModelType>(this, value, options?): Promise<InstanceType<ModelType>>

• Create a new document in the collection.

  Type Parameters

  • ModelType extends MongodbModel<IdType>

  Parameters

  • this: ModelType

  • value: Partial<ModelAttributes<InstanceType<ModelType>>>

  • Optional options: ModelAdapterOptions<InsertOneOptions>

  Returns Promise<InstanceType<ModelType>>

createMany

• createMany<ModelType>(this, values, options?): Promise<InstanceType<ModelType>[]>

• Create many documents in the collection.

  Type Parameters

  • ModelType extends MongodbModel<IdType>

  Parameters

  • this: ModelType

  • values: Partial<ModelAttributes<InstanceType<ModelType>>>[]

  • Optional options: ModelAdapterOptions<BulkWriteOptions>

  Returns Promise<InstanceType<ModelType>[]>

find

• find<ModelType>(this, id, options?): Promise<null | InstanceType<ModelType>>

• Find a document by its id.

  Type Parameters

  • ModelType extends MongodbModel<IdType>

  Parameters

  • this: ModelType

  • id: InstanceType<ModelType>["_id"]

  • Optional options: ModelAdapterOptions<FindOptions<ModelAttributes<InstanceType<ModelType>>>>

  Returns Promise<null | InstanceType<ModelType>>

findBy

• findBy<ModelType>(this, key, value, options?): Promise<null | InstanceType<ModelType>>

• Find a document using a key-value pair.

  Type Parameters

  • ModelType extends MongodbModel<IdType>

  Parameters

  • this: ModelType

  • key: string

  • value: unknown

  • Optional options: ModelAdapterOptions<FindOptions<ModelAttributes<InstanceType<ModelType>>>>

  Returns Promise<null | InstanceType<ModelType>>

findByOrFail

• findByOrFail<ModelType>(this, key, value, options?): Promise<InstanceType<ModelType>>

• Find a document using a key-value pair. Throw if no document is found.

  Type Parameters

  • ModelType extends MongodbModel<IdType>

  Parameters

  • this: ModelType

  • key: string

  • value: unknown

  • Optional options: ModelAdapterOptions<FindOptions<ModelAttributes<InstanceType<ModelType>>>>

  Returns Promise<InstanceType<ModelType>>

findMany

• findMany<ModelType>(this, ids, options?): Promise<InstanceType<ModelType>[]>

• Find many documents by their ids.

  Type Parameters

  • ModelType extends MongodbModel<IdType>

  Parameters

  • this: ModelType

  • ids: InstanceType<ModelType>["_id"][]

  • Optional options: ModelAdapterOptions<FindOptions<ModelAttributes<InstanceType<ModelType>>>>

  Returns Promise<InstanceType<ModelType>[]>

findOrFail

• findOrFail<ModelType>(this, id, options?): Promise<InstanceType<ModelType>>

• Find a document by its id. Throw if no document is found.

  Type Parameters

  • ModelType extends MongodbModel<IdType>

  Parameters

  • this: ModelType

  • id: InstanceType<ModelType>["_id"]

  • Optional options: ModelAdapterOptions<FindOptions<ModelAttributes<InstanceType<ModelType>>>>

  Returns Promise<InstanceType<ModelType>>

getCollection

• getCollection<ModelType>(this, connection?): Promise<Collection<ModelAttributes<InstanceType<ModelType>>>>

• Get the collection object from the MongoDB driver.

  Type Parameters

  • ModelType extends MongodbModel<IdType>

  Parameters

  • this: ModelType

  • Optional connection: string

  Returns Promise<Collection<ModelAttributes<InstanceType<ModelType>>>>

query

• query<ModelType>(this, filter?, options?): QueryContract<InstanceType<ModelType>>

• Returns a query

  Type Parameters

  • ModelType extends MongodbModel<IdType>

  Parameters

  • this: ModelType

  • Optional filter: Filter<ModelAttributes<InstanceType<ModelType>>>

  • Optional options: ModelAdapterOptions<Omit<FindOptions<ModelAttributes<InstanceType<ModelType>>>, ForbiddenQueryOptions>>

  Returns QueryContract<InstanceType<ModelType>>