BaseEntity | slothdb

Base abstract entity, for all entitoies The generic parameter S is the schema of the document

Type parameters

S: object

the document schema

Hierarchy

BaseEntity

Index

Constructors

constructor

Properties

_id
sloth

Methods

Constructors

constructor

new BaseEntity(factory: PouchFactory<S>, idOrProps: Partial<S> | string): BaseEntity

- Defined in models/BaseEntity.ts:23
Parameters
- factory: PouchFactory<S>
- idOrProps: Partial<S> | string
Returns BaseEntity

Properties

_id

_id: string = ""

Private sloth

sloth: SlothData<S>

Methods

exists

exists(): Promise<boolean>

- Defined in models/BaseEntity.ts:159
Returns whether the specified document exists in database Please note that this does not compare documents

Returns Promise<boolean>

getDocument

getDocument(): any

- Defined in models/BaseEntity.ts:75
Returns a list of props mapped with docKey

Returns any

Protected getProp

getProp(key: string): any

- Defined in models/BaseEntity.ts:207
Parameters
- key: string
Returns any

getProps

getProps(): S

- Defined in models/BaseEntity.ts:62
Returns a list of props following the entity schema

Returns S

Protected getRelationDescriptor

getRelationDescriptor(keyName: keyof S): RelationDescriptor & object

- Defined in models/BaseEntity.ts:211
Parameters
- keyName: keyof S
Returns RelationDescriptor & object

Protected getRelationEntity

getRelationEntity(keyName: keyof S): Promise<any>

- Defined in models/BaseEntity.ts:222
Parameters
- keyName: keyof S
Returns Promise<any>

isDirty

isDirty(): boolean

- Defined in models/BaseEntity.ts:53
Returns whether this document hhas unsaved updated properties

Returns boolean

remove

remove(): Promise<boolean>

- Defined in models/BaseEntity.ts:175
Remove a document from the database

Returns Promise<boolean>

a Promise that resolves into a boolean, true if document was removed, false if the document doesn't have a docId in its slothdata

Private removeEntityRelation

removeEntityRelation(rel: RelationDescriptor & object): Promise<void>

- Defined in models/BaseEntity.ts:235
Parameters
- rel: RelationDescriptor & object
Returns Promise<void>

Private removeRelations

removeRelations(): Promise<void>

- Defined in models/BaseEntity.ts:197
Returns Promise<void>

save

save(): Promise<S & object>

- Defined in models/BaseEntity.ts:98
Saves document to database. If the document doesn't exist, create it. If it exists, update it. If the _id was changed (due to props changing), remove to old document and create a new one

Returns Promise<S & object>

a Promise resolving into document props
- If the document was updated, the _rev prop would be defined and start with an index greater than 1
- If the document was created, the _rev prop would be defined and start with 1
- If the document was not updated, because it is not dirty, then no _rev property is returned

Generated using TypeDoc