Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "index"

Index

References

Type aliases

Variables

Functions

References

ActionType

Re-exports ActionType

HookType

Re-exports HookType

Model

Re-exports Model

array

Re-exports array

defaults

Re-exports defaults

enums

Re-exports enums

hidden

Re-exports hidden

id

Re-exports id

index

Re-exports index

indexed

Re-exports indexed

methods

Re-exports methods

middleware

Re-exports middleware

model

Re-exports model

mongoId

Re-exports mongoId

plugin

Re-exports plugin

prop

Re-exports prop

query

Re-exports query

ref

Re-exports ref

refArray

Re-exports refArray

required

Re-exports required

statics

Re-exports statics

subModel

Re-exports subModel

type

Re-exports type

unique

Re-exports unique

validators

Re-exports validators

virtual

Re-exports virtual

Type aliases

ArrayType

ArrayType<T>: T extends Primitive ? Array<T> : Array<EmbeddedDocument & T>

Type parameters

  • T

DocumentType

DocumentType<T>: T & Document

Type parameters

  • T

ModelType

ModelType<T>: Model<DocumentType<T>>

Type parameters

  • T

ObjectId

ObjectId: ObjectId

Ref

Ref<T>: T["_id"] | DocumentType<T>

Type parameters

  • T: { _id?: unknown }

RichDocumentType

RichDocumentType<T>: {} & Document

Type parameters

  • T

Variables

Const ObjectId

ObjectId: _ObjectId & (val?: string | number) => ObjectId = Types.ObjectId

Const modelCache

modelCache: WeakMap<IMongooseClass, Model<Document<any>>> = new WeakMap<IMongooseClass, ModelType<InstanceType<IMongooseClass>>>()

Const schemaCache

schemaCache: WeakMap<MongooseMeta, Schema<any>> = new WeakMap<MongooseMeta, Schema>()

Functions

buildSchema

forNestModule

  • forNestModule<T>(modelClass: T): { name: string; schema: Schema }

  • Type parameters

    Parameters

    • modelClass: T

    Returns { name: string; schema: Schema }

    • name: string
    • schema: Schema

getModel

  • getModel<T>(modelClass: T): ModelType<InstanceType<T>> & T

getModelName

  • getModelName<T>(modelClass: T): string

getSchema

  • getSchema<T>(modelClass: T): Schema

Generated using TypeDoc