Class ReferableMapEntity<T>

The ReferableMapEntity() class encapsulates any DataType as an identified entity (an entity, which contains an ID and changes can be mutable and push to the database).

Type Parameters

T extends DataType

Hierarchy

ReferableMapEntity

Index

Constructors

constructor

new ReferableMapEntity<T>(content: T, document?: string): ReferableMapEntity<T>
Type Parameters
- T extends DataType
Parameters
- content: T
- Optional document: string
Returns ReferableMapEntity<T>
- Defined in util/data/ReferableEntity.ts:21

Properties

`Private` alive

alive: boolean = true

changes

changes: Partial<T> = {}

`Private` content

content: T

document

document: undefined | string

saved

saved: Partial<T> = {}

synthesized

synthesized: boolean

The synthesized property determines whether the object is newly created in script or retrieved from the existing source.

(in-script created ReferableMapEntity will always be marked as synthesized and will be created when push to the database)

Methods

data

data(): T
The data() method returns raw data as its original form.

Returns T
- Defined in util/data/ReferableEntity.ts:106

delete

delete(): void
The delete() method deletes the entity.

Returns void
- Defined in util/data/ReferableEntity.ts:90

deleteField

deleteField<U>(field: U): void
The deleteField() method deletes the provided field from the entity.
Type Parameters
- U extends string | number | symbol
Parameters
- field: U
  
  Field name.
Returns void
- Defined in util/data/ReferableEntity.ts:78

get

get<U>(field: U): T[U]
The get() method gets the value of the provided field.
Type Parameters
- U extends string | number | symbol
Parameters
- field: U
  
  Field name.
Returns T[U]
- Defined in util/data/ReferableEntity.ts:70

getOriginal

getOriginal(): T
The getOriginal() method gives the original content of the entity before changes.

Returns T
- Defined in util/data/ReferableEntity.ts:113

isDeleted

isDeleted(): boolean
The isDeleted() method determines whether the entity is deleted or not.

Returns boolean
- Defined in util/data/ReferableEntity.ts:99

isEdited

isEdited(): boolean
The isEdited() method determines whether the entity has been edited or not.

Returns boolean
- Defined in util/data/ReferableEntity.ts:32

set

set(value: T): ReferableMapEntity<T>
The set() method sets the entire entity to the provided value.
Parameters
- value: T
  
  Acceptable field value.
Returns ReferableMapEntity<T>
- Defined in util/data/ReferableEntity.ts:60

setSynthesized

setSynthesized(syn: boolean): void
The setSynthesized() method sets the synthesized property.
Parameters
- syn: boolean
  
  value
Returns void
- Defined in util/data/ReferableEntity.ts:121

update

update<U>(field: U, value: T[U]): ReferableMapEntity<T>
The update() method updates existed field with the provided value.
Type Parameters
- U extends string | number | symbol
Parameters
- field: U
  
  Field name
- value: T[U]
  
  Acceptable field value.
Returns ReferableMapEntity<T>
- Defined in util/data/ReferableEntity.ts:46

Class ReferableMapEntity<T>

Type Parameters

T extends DataType

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends DataType

Parameters

content: T

Optional document: string

Returns ReferableMapEntity<T>

Properties

Private alive

changes

Private content

document

saved

synthesized

Methods

data

Returns T

delete

Returns void

deleteField

Type Parameters

U extends string | number | symbol

Parameters

field: U

Returns void

get

Type Parameters

U extends string | number | symbol

Parameters

field: U

Returns T[U]

getOriginal

Returns T

isDeleted

Returns boolean

isEdited

Returns boolean

set

Parameters

value: T

Returns ReferableMapEntity<T>

setSynthesized

Parameters

syn: boolean

Returns void

update

Type Parameters

U extends string | number | symbol

Parameters

field: U

value: T[U]

Returns ReferableMapEntity<T>

Settings

Member Visibility

Theme

`Optional` document: string

`Private` alive

`Private` content