Class MongoEntity<T>

Type parameters

T = any

Hierarchy

Serializable<T>
- MongoEntity

Index

Constructors

constructor

Properties

_id

Constructors

constructor

new MongoEntity<T>(partial?: DeepPartial<T>): MongoEntity<T>

Inherited from Serializable<T>.constructor
- Defined in node_modules/class-json/lib/class-json.d.ts:93
Type parameters
- T = any
Parameters
- Optional partial: DeepPartial<T>
Returns MongoEntity<T>

Properties

_id

_id: string

Methods

assign

assign(partial?: Partial<T>): MongoEntity<T>

Inherited from Serializable.assign
- Defined in node_modules/class-json/lib/class-json.d.ts:99
Parameters
- Optional partial: Partial<T>
Returns MongoEntity<T>

del

del(): Promise<any>

- Defined in src/MongoEntity.ts:265
Returns Promise<any>

patch

patch<T>(patch: UpdateQuery<T> | DeepPartial<T>, opts: { deep: true }): Promise<T>

- Defined in src/MongoEntity.ts:270
Type parameters
- T: MongoEntity<any, T>
Parameters
- patch: UpdateQuery<T> | DeepPartial<T>
- opts: { deep: true }
  - deep: true
Returns Promise<T>

toJSON

toJSON(settings?: JsonSettings): any

Inherited from Serializable.toJSON
- Defined in node_modules/class-json/lib/class-json.d.ts:98
Parameters
- Optional settings: JsonSettings
Returns any

toJson

toJson(settings?: JsonSettings): any

Inherited from Serializable.toJson
- Defined in node_modules/class-json/lib/class-json.d.ts:97
Parameters
- Optional settings: JsonSettings
Returns any

upsert

upsert(): Promise<MongoEntity<T>>

- Defined in src/MongoEntity.ts:262
Returns Promise<MongoEntity<T>>

Static aggregateMany

aggregateMany<TOut, T>(pipeline?: IAggrPipeline<any>[], options?: { Type?: Constructor<TOut> } & CollectionAggregationOptions): Promise<TOut[]>

- Defined in src/MongoEntity.ts:127
Type parameters
- TOut = any
- T: typeof MongoEntity = any
Parameters
- Optional pipeline: IAggrPipeline<any>[]
- Optional options: { Type?: Constructor<TOut> } & CollectionAggregationOptions
Returns Promise<TOut[]>

Static aggregateManyPaged

aggregateManyPaged<TOut, T>(pipeline?: IAggrPipeline<any>[], options?: { Type?: Constructor<TOut> } & CollectionAggregationOptions): Promise<{ collection: TOut[]; total: number }>

- Defined in src/MongoEntity.ts:139
Type parameters
- TOut = any
- T: typeof MongoEntity = any
Parameters
- Optional pipeline: IAggrPipeline<any>[]
- Optional options: { Type?: Constructor<TOut> } & CollectionAggregationOptions
Returns Promise<{ collection: TOut[]; total: number }>

Static count

count<T>(query?: FilterQuery<T>): Promise<any>

- Defined in src/MongoEntity.ts:173
Type parameters
- T: typeof MongoEntity
Parameters
- Optional query: FilterQuery<T>
Returns Promise<any>

Static del

del<T>(entity: T): Promise<any>

- Defined in src/MongoEntity.ts:189
Type parameters
- T: MongoEntity<any, T>
Parameters
- entity: T
Returns Promise<any>

Static delMany

delMany<T>(arr: T[]): Promise<any>

- Defined in src/MongoEntity.ts:193
Type parameters
- T: MongoEntity<any, T>
Parameters
- arr: T[]
Returns Promise<any>

Static fetch

fetch<T>(query: FilterQuery<InstanceType<T>>, options?: FindOptions<InstanceType<T>> & FindOneOptions): Promise<InstanceType<T>>

- Defined in src/MongoEntity.ts:55
Equivalent to findOne method.

Type parameters
- T: typeof MongoEntity
Parameters
- query: FilterQuery<InstanceType<T>>
  
  (https://mongodb.github.io/node-mongodb-native/4.0/modules.html#filter)
- Optional options: FindOptions<InstanceType<T>> & FindOneOptions
  
  @see https://mongodb.github.io/node-mongodb-native/4.0/interfaces/findoptions.html
Returns Promise<InstanceType<T>>

Static fetchMany

fetchMany<T>(query?: FilterQuery<InstanceType<T>>, options?: FindOptions<InstanceType<T>> & FindOneOptions): Promise<InstanceType<T>[]>

- Defined in src/MongoEntity.ts:78
Type parameters
- T: typeof MongoEntity
Parameters
- Optional query: FilterQuery<InstanceType<T>>
- Optional options: FindOptions<InstanceType<T>> & FindOneOptions
Returns Promise<InstanceType<T>[]>

Static fetchManyPaged

fetchManyPaged<T>(query?: FilterQuery<InstanceType<T>>, options?: FindOptions<InstanceType<T>> & FindOneOptions): Promise<{ collection: InstanceType<T>[]; total: number }>

- Defined in src/MongoEntity.ts:101
Type parameters
- T: typeof MongoEntity
Parameters
- Optional query: FilterQuery<InstanceType<T>>
- Optional options: FindOptions<InstanceType<T>> & FindOneOptions
Returns Promise<{ collection: InstanceType<T>[]; total: number }>

Static fetchManyPagedPartial

fetchManyPagedPartial<T, P>(query: FilterQuery<InstanceType<T>>, options: Omit<FindOneOptions, "projection"> & FindOptionsProjected<InstanceType<T>, P>): Promise<{ collection: TDeepPickByProjection<InstanceType<T>, P>[]; total: number }>

- Defined in src/MongoEntity.ts:117
Type parameters
- T: typeof MongoEntity
- P: TProjection<InstanceType<T>>
Parameters
- query: FilterQuery<InstanceType<T>>
- options: Omit<FindOneOptions, "projection"> & FindOptionsProjected<InstanceType<T>, P>
Returns Promise<{ collection: TDeepPickByProjection<InstanceType<T>, P>[]; total: number }>

Static fetchManyPartial

fetchManyPartial<T, P>(query: FilterQuery<InstanceType<T>>, options: Omit<FindOneOptions, "projection"> & FindOptionsProjected<InstanceType<T>, P>): Promise<TDeepPickByProjection<InstanceType<T>, P>[]>

- Defined in src/MongoEntity.ts:91
Type parameters
- T: typeof MongoEntity
- P: TProjection<InstanceType<T>>
Parameters
- query: FilterQuery<InstanceType<T>>
- options: Omit<FindOneOptions, "projection"> & FindOptionsProjected<InstanceType<T>, P>
Returns Promise<TDeepPickByProjection<InstanceType<T>, P>[]>

Static fetchPartial

fetchPartial<T, P>(query: FilterQuery<InstanceType<T>>, options: Omit<FindOneOptions, "projection"> & FindOptionsProjected<InstanceType<T>, P>): Promise<TDeepPickByProjection<InstanceType<T>, P>>

- Defined in src/MongoEntity.ts:68
Type parameters
- T: typeof MongoEntity
- P: TProjection<InstanceType<T>>
Parameters
- query: FilterQuery<InstanceType<T>>
- options: Omit<FindOneOptions, "projection"> & FindOptionsProjected<InstanceType<T>, P>
Returns Promise<TDeepPickByProjection<InstanceType<T>, P>>

Static fromJSON

fromJSON<T>(json: any, settings?: JsonSettings & IType): InstanceType<T>

Inherited from Serializable.fromJSON
- Defined in node_modules/class-json/lib/class-json.d.ts:95
Type parameters
- T: typeof Serializable
Parameters
- json: any
- Optional settings: JsonSettings & IType
Returns InstanceType<T>

Static fromJson

fromJson<T>(json: any, settings?: JsonSettings & IType): InstanceType<T>

Inherited from Serializable.fromJson
- Defined in node_modules/class-json/lib/class-json.d.ts:94
Type parameters
- T: typeof Serializable
Parameters
- json: any
- Optional settings: JsonSettings & IType
Returns InstanceType<T>

Static getCollection

getCollection(): Promise<Collection<any>>

- Defined in src/MongoEntity.ts:255
Returns Promise<Collection<any>>

Static getDb

getDb(server?: string): Promise<Db>

- Defined in src/MongoEntity.ts:259
Parameters
- Optional server: string
Returns Promise<Db>

Static patch

patch<T>(instance: T, patch: Partial<T> | UpdateQuery<T>): Promise<T>

- Defined in src/MongoEntity.ts:198
Type parameters
- T: MongoEntity<any, T>
Parameters
- instance: T
- patch: Partial<T> | UpdateQuery<T>
Returns Promise<T>

Static patchBy

patchBy<T>(finder: FilterQuery<T>, patch: Partial<T> | UpdateQuery<T>): Promise<WriteOpResult>

- Defined in src/MongoEntity.ts:229
Type parameters
- T: MongoEntity<any, T>
Parameters
- finder: FilterQuery<T>
- patch: Partial<T> | UpdateQuery<T>
Returns Promise<WriteOpResult>

Static patchDeeply

patchDeeply<T>(instance: T, patch: Partial<T> | UpdateQuery<T>): Promise<T>

- Defined in src/MongoEntity.ts:205
Type parameters
- T: MongoEntity<any, T>
Parameters
- instance: T
- patch: Partial<T> | UpdateQuery<T>
Returns Promise<T>

Static patchDeeplyBy

patchDeeplyBy<T>(finder: FilterQuery<T>, patch: DeepPartial<T>): Promise<WriteOpResult>

- Defined in src/MongoEntity.ts:221
Find document by filter query, and patch it.

Type parameters
- T: MongoEntity<any, T>
Parameters
- finder: FilterQuery<T>
- patch: DeepPartial<T>
Returns Promise<WriteOpResult>

Static patchMany

patchMany<T>(arr: [FilterQuery<T>, DeepPartial<T> | UpdateQuery<T>][]): Promise<void>

- Defined in src/MongoEntity.ts:213
Type parameters
- T: MongoEntity<any, T>
Parameters
- arr: [FilterQuery<T>, DeepPartial<T> | UpdateQuery<T>][]
Returns Promise<void>

Static patchMultipleBy

patchMultipleBy<T>(finder: FilterQuery<T>, patch: DeepPartial<T> | UpdateQuery<T>): Promise<WriteOpResult>

- Defined in src/MongoEntity.ts:238
Type parameters
- T: MongoEntity<any, T>
Parameters
- finder: FilterQuery<T>
- patch: DeepPartial<T> | UpdateQuery<T>
Returns Promise<WriteOpResult>

Static patchMultipleDeeplyBy

patchMultipleDeeplyBy<T>(finder: FilterQuery<T>, patch: DeepPartial<T> | UpdateQuery<T>): Promise<WriteOpResult>

- Defined in src/MongoEntity.ts:246
Type parameters
- T: MongoEntity<any, T>
Parameters
- finder: FilterQuery<T>
- patch: DeepPartial<T> | UpdateQuery<T>
Returns Promise<WriteOpResult>

Static upsert

upsert<T>(instance: T): Promise<T>

- Defined in src/MongoEntity.ts:177
Type parameters
- T: MongoEntity<any, T>
Parameters
- instance: T
Returns Promise<T>

Static upsertBy

upsertBy<T>(finder: TFindQuery<T>, instance: T): Promise<T>

- Defined in src/MongoEntity.ts:180
Type parameters
- T: MongoEntity<any, T>
Parameters
- finder: TFindQuery<T>
- instance: T
Returns Promise<T>

Static upsertMany

upsertMany<T>(arr: T[]): Promise<T[]>

- Defined in src/MongoEntity.ts:183
Type parameters
- T: MongoEntity<any, T>
Parameters
- arr: T[]
Returns Promise<T[]>

Static upsertManyBy

upsertManyBy<T>(finder: TFindQuery<T>, arr: T[]): Promise<T[]>

- Defined in src/MongoEntity.ts:186
Type parameters
- T: MongoEntity<any, T>
Parameters
- finder: TFindQuery<T>
- arr: T[]
Returns Promise<T[]>

Static validate

validate(x: any, settings?: IValidationSettings<any>): IRuleError<any>[]

Inherited from Serializable.validate
- Defined in node_modules/class-json/lib/class-json.d.ts:96
Parameters
- x: any
- Optional settings: IValidationSettings<any>
Returns IRuleError<any>[]

Generated using TypeDoc