Class Entity<ACS>

Type parameters

ACS: AttrConfigSet = typeof EmptyObject

Hierarchy

Entity

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Entity(attrConfigSet: ACS, data?: ResolveConstructorData<ACS>): Entity

- Defined in packages/core/src/Entity.ts:89
Creates a new Entity instance. The attrConfigSet defines the attributes available on the Entity instance. Values defined in attrConfigSet are trusted and therefore not sanitized, normalized nor validated. Data provided via data must be compatible with the data expected by [[Entity.fill()]] but, unlike [[Entity.fill()]], may also include values for immutable attributes.

Parameters
- attrConfigSet: ACS
- Default value data: ResolveConstructorData<ACS> = {}
Returns Entity

Properties

Private #attrConfigSet

#attrConfigSet: ACS

Private #immutable

#immutable: ResolveImmutableAttrSet<ACS>

Private #modified

#modified: Set<AttrName> = new Set<ResolveMutableAttrName<ACS>>()

Private #mutable

#mutable: ResolveMutableAttrSet<ACS>

Methods

all

all(): ResolveAttrSet<ACS>

- Defined in packages/core/src/Entity.ts:167
Returns an attribute set of all attributes.

Returns ResolveAttrSet<ACS>

callable

callable(): ResolveCallableAttrSet<ACS>

- Defined in packages/core/src/Entity.ts:174
Returns an attribute set of all callable (non-writable) attributes.

Returns ResolveCallableAttrSet<ACS>

clearModified

clearModified(): this

- Defined in packages/core/src/Entity.ts:289
Clears the modified attribute state. Typically used after calling an update/save endpoint to signify that the instance is in sync with the upstream datasource.

Returns this

fill

fill(data: ResolveFillData<ACS>): this

- Defined in packages/core/src/Entity.ts:278
Sets multiple attribute values using the provided data. The incoming data is parsed into an attribute set using [[Entity.parseData()]], before being sanitized, normalized and validated.

Parameters
- data: ResolveFillData<ACS>
Returns this

hidden

hidden(): ResolveHiddenAttrSet<ACS>

- Defined in packages/core/src/Entity.ts:208
Returns an attribute set of all attributes that have been configured as hidden.

Returns ResolveHiddenAttrSet<ACS>

immutable

immutable(): ResolveImmutableAttrSet<ACS>

- Defined in packages/core/src/Entity.ts:194
Returns an attribute set of all attributes that have been configured as immutable.

Returns ResolveImmutableAttrSet<ACS>

many

many<N>(names: N): Pick<ResolveAttrSet<ACS>, typeof names[number]>

- Defined in packages/core/src/Entity.ts:157
Returns an attribute set of the attributes provided in names.

Type parameters
- N: ResolveAttrName<ACS>[]
Parameters
- names: N
Returns Pick<ResolveAttrSet<ACS>, typeof names[number]>

modified

modified(): Partial<ResolveMutableAttrSet<ACS>>

- Defined in packages/core/src/Entity.ts:229
Returns an attribute set of all attributes that have been modified since instantiation or the last call to [[Entity.clearModified()]].

Returns Partial<ResolveMutableAttrSet<ACS>>

mutable

mutable(): ResolveMutableAttrSet<ACS>

- Defined in packages/core/src/Entity.ts:201
Returns an attribute set of all attributes that have not been configured as immutable.

Returns ResolveMutableAttrSet<ACS>

normalize

normalize<K, V>(name: K, value: V): V

- Defined in packages/core/src/Entity.ts:324
Normalizes a value using the configured normalizer function for the attribute name. If the attribute does not have a normalizer function configured then that value is returned as-is. The function will have this scoped to the Entity instance.

Type parameters
- K: ResolveWritableAttrName<ACS>
- V: ResolveWritableAttrSet<ACS>[K]
Parameters
- name: K
- value: V
Returns V

one

one<K>(name: K): ResolveAttrSet<ACS>[K]

- Defined in packages/core/src/Entity.ts:135
Returns the value of the attribute provided in name.

Type parameters
- K: ResolveAttrName<ACS>
Parameters
- name: K
Returns ResolveAttrSet<ACS>[K]

parseData

parseData(data: unknown): AttrSet

- Defined in packages/core/src/Entity.ts:371
Attempts to parse incoming data which may be an attribute set, an Entity instance or a JSON string.

Parameters
- data: unknown
Returns AttrSet

sanitize

sanitize<K>(name: K, value: unknown): ResolveWritableAttrSet<ACS>[K]

- Defined in packages/core/src/Entity.ts:301
Sanitizes a value using the configured sanitizer function for the attribute name. The function will have this scoped to the Entity instance.

Type parameters
- K: ResolveWritableAttrName<ACS>
Parameters
- name: K
- value: unknown
Returns ResolveWritableAttrSet<ACS>[K]

set

set<K>(name: K, value: ResolveMutableAttrSet<ACS>[K]): this

- Defined in packages/core/src/Entity.ts:240
Sets the value for the attribute name. Values can only be set for mutable, writable attributes. The value will be sanitized, normalized and validated.

Type parameters
- K: ResolveMutableAttrName<ACS>
Parameters
- name: K
- value: ResolveMutableAttrSet<ACS>[K]
Returns this

toJSON

toJSON(): ResolveVisibleAttrSet<ACS>

- Defined in packages/core/src/Entity.ts:402
Returns the data to expose when stringifying the instance to JSON.

Returns ResolveVisibleAttrSet<ACS>

toString

toString(): string

- Defined in packages/core/src/Entity.ts:394
Stringifies the instance to JSON.

Returns string

validate

validate<K>(name: K, value: ResolveWritableAttrSet<ACS>[K]): boolean

- Defined in packages/core/src/Entity.ts:347
Validates a value using the configured validator function for the attribute name. If the attribute does not have a validator function configured then that value is assumed valid. The function will have this scoped to the Entity instance.

Type parameters
- K: ResolveWritableAttrName<ACS>
Parameters
- name: K
- value: ResolveWritableAttrSet<ACS>[K]
Returns boolean

visible

visible(): ResolveVisibleAttrSet<ACS>

- Defined in packages/core/src/Entity.ts:218
Returns an attribute set of all attributes that have not been configured as hidden.

Returns ResolveVisibleAttrSet<ACS>

writable

writable(): ResolveWritableAttrSet<ACS>

- Defined in packages/core/src/Entity.ts:184
Returns an attribute set an all writable (non-callable) attributes.

Returns ResolveWritableAttrSet<ACS>

Generated using TypeDoc