Skip to main content

Abstract Class: RecoverableBaseMongoEntity

Defined in: service-core/src/models/RecoverableBaseMongoEntity.ts:20

The RecoverableBaseMongoEntity provides an entity base class for those classes wishing to implement soft delete capability. A soft delete means that a delete operation does not remove the entity from the database but instead simply marks it as deleted. To completely remove the entity from the database the user must explicitly specify the entity to be purged.

Extends

Constructors

Constructor

new RecoverableBaseMongoEntity(other?): RecoverableBaseMongoEntity

Defined in: service-core/src/models/RecoverableBaseMongoEntity.ts:27

Parameters

other?

Partial<RecoverableBaseMongoEntity>

Returns

RecoverableBaseMongoEntity

Overrides

RecoverableBaseEntity.constructor

Properties

_id?

optional _id?: any

Defined in: service-core/src/models/RecoverableBaseMongoEntity.ts:25

The internal unique identifier used by MongoDB.


dateCreated

dateCreated: Date

Defined in: service-core/src/models/BaseEntity.ts:35

The date and time that the entity was created.

Inherited from

RecoverableBaseEntity.dateCreated


dateModified

dateModified: Date

Defined in: service-core/src/models/BaseEntity.ts:43

The date and time that the entity was last modified.

Inherited from

RecoverableBaseEntity.dateModified


deleted

deleted: boolean = false

Defined in: service-core/src/models/RecoverableBaseEntity.ts:20

Indicates if the document has been soft deleted.

Inherited from

RecoverableBaseEntity.deleted


uid

uid: string

Defined in: service-core/src/models/BaseEntity.ts:27

The universally unique identifier of the entity.

Inherited from

RecoverableBaseEntity.uid


version

version: number = 0

Defined in: service-core/src/models/BaseEntity.ts:50

The optimistic lock version.

Inherited from

RecoverableBaseEntity.version