Class AttributesBase<T>`Abstract`

Base class for DOT objects with attributes.

Type Parameters

T extends AttributeKey

Hierarchy (View Summary)

DotObject
- AttributesBase

Implements

Attributes<T>

Index

Constructors

Accessors

Methods

apply clear delete get set

Constructors

constructor

new AttributesBase<T extends AttributeKey>(
attributes?: AttributesObject<T>,
): AttributesBase<T>
Type Parameters
- T extends AttributeKey
Parameters
- Optionalattributes: AttributesObject<T>
Returns AttributesBase<T>
Overrides DotObject.constructor
- Defined in packages/core/src/AttributesBase.ts:21

Accessors

size

get size(): number
Size of the set of keys and values held by the DOT object.

Returns number
Implementation of Attributes.size
- Defined in packages/core/src/AttributesBase.ts:32

values

get values(): readonly [T, Attribute<T>][]
The key/value tuples of the object attributes.

Returns readonly [T, Attribute<T>][]
Implementation of Attributes.values
- Defined in packages/core/src/AttributesBase.ts:28

Methods

apply

apply(attributes: AttributesObject<T> | AttributesEntities<T>): void
Apply keys and values that can be specified for DOT objects collectively.
Parameters
- attributes: AttributesObject<T> | AttributesEntities<T>
  An array of objects or tuples of attribute key/value pairs.
Returns void
Implementation of Attributes.apply
- Defined in packages/core/src/AttributesBase.ts:50

clear

clear(): void
Delete all attributes specified for the DOT object.

Returns void
Implementation of Attributes.clear
- Defined in packages/core/src/AttributesBase.ts:59

delete

delete(key: T): void
Delete the value of an attribute from a DOT object by specifying a key.
Parameters
- key: T
Returns void
Implementation of Attributes.delete
- Defined in packages/core/src/AttributesBase.ts:46

get

get<K extends AttributeKey>(key: K): undefined | Attribute<K>
Get the value of an attribute by a DOT object by specifying its key.

If the value corresponding to the key does not exist, undefined is returned.
Type Parameters
- K extends AttributeKey
Parameters
- key: K
Returns undefined | Attribute<K>
Implementation of Attributes.get
- Defined in packages/core/src/AttributesBase.ts:36

set

set<K extends AttributeKey>(key: K, value: Attribute<K>): void
Set a value, by specifying the key of the attributes in the DOT object.
Type Parameters
- K extends AttributeKey
Parameters
- key: K
- value: Attribute<K>
Returns void
Implementation of Attributes.set
- Defined in packages/core/src/AttributesBase.ts:40