@rapidrest/service-core 1.0.0-rc.9 → 1.0.0

package/docs/reference/classes/RecoverableBaseEntity.md

@@ -1,114 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / RecoverableBaseEntity
-
-# Abstract Class: RecoverableBaseEntity
-
-Defined in: [src/models/RecoverableBaseEntity.ts:15](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/models/RecoverableBaseEntity.ts#L15)
-
-The `RecoverableBaseEntity` 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.
-
-## Author
-
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-
-## Extends
-
-- [`BaseEntity`](BaseEntity.md)
-
-## Extended by
-
-- [`RecoverableBaseMongoEntity`](RecoverableBaseMongoEntity.md)
-
-## Constructors
-
-### Constructor
-
-> **new RecoverableBaseEntity**(`other?`): `RecoverableBaseEntity`
-
-Defined in: [src/models/RecoverableBaseEntity.ts:22](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/models/RecoverableBaseEntity.ts#L22)
-
-#### Parameters
-
-##### other?
-
-`Partial`\<`RecoverableBaseEntity`\>
-
-#### Returns
-
-`RecoverableBaseEntity`
-
-#### Overrides
-
-[`BaseEntity`](BaseEntity.md).[`constructor`](BaseEntity.md#constructor)
-
-## Properties
-
-### dateCreated
-
-> **dateCreated**: `Date`
-
-Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/models/BaseEntity.ts#L35)
-
-The date and time that the entity was created.
-
-#### Inherited from
-
-[`BaseEntity`](BaseEntity.md).[`dateCreated`](BaseEntity.md#datecreated)
-
-***
-
-### dateModified
-
-> **dateModified**: `Date`
-
-Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/models/BaseEntity.ts#L43)
-
-The date and time that the entity was last modified.
-
-#### Inherited from
-
-[`BaseEntity`](BaseEntity.md).[`dateModified`](BaseEntity.md#datemodified)
-
-***
-
-### deleted
-
-> **deleted**: `boolean` = `false`
-
-Defined in: [src/models/RecoverableBaseEntity.ts:20](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/models/RecoverableBaseEntity.ts#L20)
-
-Indicates if the document has been soft deleted.
-
-***
-
-### uid
-
-> **uid**: `string`
-
-Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/models/BaseEntity.ts#L27)
-
-The universally unique identifier of the entity.
-
-#### Inherited from
-
-[`BaseEntity`](BaseEntity.md).[`uid`](BaseEntity.md#uid)
-
-***
-
-### version
-
-> **version**: `number` = `0`
-
-Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/models/BaseEntity.ts#L50)
-
-The optimistic lock version.
-
-#### Inherited from
-
-[`BaseEntity`](BaseEntity.md).[`version`](BaseEntity.md#version)

package/docs/reference/classes/RecoverableBaseMongoEntity.md

@@ -1,124 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / RecoverableBaseMongoEntity
-
-# Abstract Class: RecoverableBaseMongoEntity
-
-Defined in: [src/models/RecoverableBaseMongoEntity.ts:20](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/models/RecoverableBaseMongoEntity.ts#L20)
-
-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.
-
-## Author
-
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-
-## Extends
-
-- [`RecoverableBaseEntity`](RecoverableBaseEntity.md)
-
-## Constructors
-
-### Constructor
-
-> **new RecoverableBaseMongoEntity**(`other?`): `RecoverableBaseMongoEntity`
-
-Defined in: [src/models/RecoverableBaseMongoEntity.ts:27](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/models/RecoverableBaseMongoEntity.ts#L27)
-
-#### Parameters
-
-##### other?
-
-`Partial`\<`RecoverableBaseMongoEntity`\>
-
-#### Returns
-
-`RecoverableBaseMongoEntity`
-
-#### Overrides
-
-[`RecoverableBaseEntity`](RecoverableBaseEntity.md).[`constructor`](RecoverableBaseEntity.md#constructor)
-
-## Properties
-
-### \_id?
-
-> `optional` **\_id?**: `any`
-
-Defined in: [src/models/RecoverableBaseMongoEntity.ts:25](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/models/RecoverableBaseMongoEntity.ts#L25)
-
-The internal unique identifier used by MongoDB.
-
-***
-
-### dateCreated
-
-> **dateCreated**: `Date`
-
-Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/models/BaseEntity.ts#L35)
-
-The date and time that the entity was created.
-
-#### Inherited from
-
-[`RecoverableBaseEntity`](RecoverableBaseEntity.md).[`dateCreated`](RecoverableBaseEntity.md#datecreated)
-
-***
-
-### dateModified
-
-> **dateModified**: `Date`
-
-Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/models/BaseEntity.ts#L43)
-
-The date and time that the entity was last modified.
-
-#### Inherited from
-
-[`RecoverableBaseEntity`](RecoverableBaseEntity.md).[`dateModified`](RecoverableBaseEntity.md#datemodified)
-
-***
-
-### deleted
-
-> **deleted**: `boolean` = `false`
-
-Defined in: [src/models/RecoverableBaseEntity.ts:20](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/models/RecoverableBaseEntity.ts#L20)
-
-Indicates if the document has been soft deleted.
-
-#### Inherited from
-
-[`RecoverableBaseEntity`](RecoverableBaseEntity.md).[`deleted`](RecoverableBaseEntity.md#deleted)
-
-***
-
-### uid
-
-> **uid**: `string`
-
-Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/models/BaseEntity.ts#L27)
-
-The universally unique identifier of the entity.
-
-#### Inherited from
-
-[`RecoverableBaseEntity`](RecoverableBaseEntity.md).[`uid`](RecoverableBaseEntity.md#uid)
-
-***
-
-### version
-
-> **version**: `number` = `0`
-
-Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/models/BaseEntity.ts#L50)
-
-The optimistic lock version.
-
-#### Inherited from
-
-[`RecoverableBaseEntity`](RecoverableBaseEntity.md).[`version`](RecoverableBaseEntity.md#version)