Class EntityRepository<Model>

Type parameters

Model: EntityInterface

Hierarchy

EntityRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new EntityRepository<Model>(em: EntityManager, classType: ClassConstructor<Model>): EntityRepository<Model>

- Defined in src/entity/repository.ts:9
Type parameters
- Model: EntityInterface
Parameters
- em: EntityManager
- classType: ClassConstructor<Model>
Returns EntityRepository<Model>

Properties

Protected Readonly classType

classType: ClassConstructor<Model>

Protected Readonly em

em: EntityManager

Methods

count

count(query: Filter<Model>, options?: CountDocumentsOptions): Promise<number>

- Defined in src/entity/repository.ts:31
Parameters
- query: Filter<Model>
- options: CountDocumentsOptions = {}
Returns Promise<number>

deleteMany

deleteMany(query: Filter<Model>, ...args: any): Promise<DeleteResult>

- Defined in src/entity/repository.ts:43
Parameters
- query: Filter<Model>
- Rest ...args: any
Returns Promise<DeleteResult>

deleteOne

deleteOne(query: Filter<Model>, options?: DeleteOptions): Promise<DeleteResult>

- Defined in src/entity/repository.ts:39
Parameters
- query: Filter<Model>
- options: DeleteOptions = {}
Returns Promise<DeleteResult>

find

find(query: Filter<Model>, options?: FindOptions<Model>): Promise<FindCursor<WithId<Model>>>

- Defined in src/entity/repository.ts:27
Parameters
- query: Filter<Model>
- options: FindOptions<Model> = {}
Returns Promise<FindCursor<WithId<Model>>>

findOne

findOne(query: Filter<Model>, options?: FindOptions<Document>): Promise<undefined | WithId<Model>>

- Defined in src/entity/repository.ts:35
Parameters
- query: Filter<Model>
- options: FindOptions<Document> = {}
Returns Promise<undefined | WithId<Model>>

fromPlain

fromPlain(data: object | object[], options?: ClassTransformOptions): Model

- Defined in src/entity/repository.ts:63
Parameters
- data: object | object[]
- Optional options: ClassTransformOptions
Returns Model

getClassType

getClassType(): ClassConstructor<Model>

- Defined in src/entity/repository.ts:11
Returns ClassConstructor<Model>

getEm

getEm(): EntityManager

- Defined in src/entity/repository.ts:15
Returns EntityManager

getRelationship

getRelationship<E>(object: Model, property: string, options?: FindOptions<Document>): Promise<undefined | WithId<E>>

- Defined in src/entity/repository.ts:47
Type parameters
- E: EntityInterface
Parameters
- object: Model
- property: string
- options: FindOptions<Document> = {}
Returns Promise<undefined | WithId<E>>

getRelationships

getRelationships<E>(object: Model, property: string, options?: FindOptions<Document>): Promise<WithId<E>[]>

- Defined in src/entity/repository.ts:55
Type parameters
- E: EntityInterface
Parameters
- object: Model
- property: string
- options: FindOptions<Document> = {}
Returns Promise<WithId<E>[]>

merge

merge(entity: Model | WithId<Model>, data: Model | WithId<Model>, excludePrefixes?: string[]): Model | WithId<Model>

- Defined in src/entity/repository.ts:67
Parameters
- entity: Model | WithId<Model>
- data: Model | WithId<Model>
- Optional excludePrefixes: string[]
Returns Model | WithId<Model>

save

save(entity: Model | WithId<Model>, ...args: any[]): Promise<WithId<Model>>

- Defined in src/entity/repository.ts:19
Parameters
- entity: Model | WithId<Model>
- Rest ...args: any[]
Returns Promise<WithId<Model>>

validate

validate(entity: Model, validatorOptions?: ValidatorOptions, throwError?: boolean): Promise<ValidationError[]>

- Defined in src/entity/repository.ts:71
Parameters
- entity: Model
- validatorOptions: ValidatorOptions = {}
- throwError: boolean = false
Returns Promise<ValidationError[]>

watch

watch(pipes?: Document[], options?: ChangeStreamOptions): ChangeStream<WithId<Model>>

- Defined in src/entity/repository.ts:23
Parameters
- Optional pipes: Document[]
- options: ChangeStreamOptions = {}
Returns ChangeStream<WithId<Model>>