Class SingleUcAttr<T>

Typed charge metadata attribute that stores single, last assigned, value.

Type Parameters

out T = unknown

Attribute value type.

Hierarchy

UcMetaAttr<T, T, T>
- SingleUcAttr

Index

Constructors

Accessors

Methods

charge clone extract extractAll merge store

Constructors

constructor

new SingleUcAttr<out T>(name, uid?): SingleUcAttr<T>
Constructs attribute.
Type Parameters
- out T = unknown
Parameters
- name: string
  
  Attribute name.
- Optional uid: unknown
  
  Unique attribute identifier. this by default.
  
  Optional
Returns SingleUcAttr<T>
Inherited from UcMetaAttr.constructor
- Defined in ucnot/churi/src/schema/meta/uc-meta-attr.ts:31

Accessors

name

get name(): string
Attribute name.

Returns string
Inherited from UcMetaAttr.name
- Defined in ucnot/churi/src/schema/meta/uc-meta-attr.ts:39

uid

get uid(): unknown
Unique attribute identifier.

Different attributes with the same identifier share the same value.

Returns unknown
Inherited from UcMetaAttr.uid
- Defined in ucnot/churi/src/schema/meta/uc-meta-attr.ts:48

Methods

charge

charge(rx, data, meta): void
Represents this attribute as charge and transfers it to the given charge receiver.

Called by UcMeta#toUC method when attribute is present within.
Parameters
- rx: AllUcrx
  
  Charge receiver.
- data: T
  
  Stored attribute data.
- meta: UcMeta
  
  Source metadata.
Returns void
Inherited from UcMetaAttr.charge
- Defined in ucnot/churi/src/schema/meta/uc-meta-attr.ts:115

clone

clone(data): T
Clones attribute data.

Called when metadata actually cloned. This happens when one of the clones modified.
Parameters
- data: T
  
  Data to clone.
Returns T
Cloned data.
Overrides UcMetaAttr.clone
- Defined in ucnot/churi/src/schema/meta/single.uc-attr.ts:26

extract

extract(data, meta): undefined | T
Extracts attribute value from metadata.
Parameters
- data: undefined | T
  
  Stored attribute data or undefined if nothing stored.
- meta: UcMeta
  
  Source metadata to extract the value from.
Returns undefined | T
Either extracted attribute value, or undefined if nothing extracted.
Overrides UcMetaAttr.extract
- Defined in ucnot/churi/src/schema/meta/single.uc-attr.ts:11

extractAll

extractAll(data, meta): T[]
Extracts all attribute values.
Parameters
- data: undefined | T
  
  Stored attribute data or undefined if nothing stored.
- meta: UcMeta
  
  Source metadata to extract values from.
Returns T[]
Either array of extracted attribute values, or empty array if nothing extracted.
Overrides UcMetaAttr.extractAll
- Defined in ucnot/churi/src/schema/meta/single.uc-attr.ts:16

merge

merge(first, second): T
Merges two attribute data instances.

Called when metadata instances merged.
Parameters
- first: T
  
  First attribute data instance to merge.
- second: T
  
  Second attribute data instance to merge.
Returns T
Merged attribute data.
Overrides UcMetaAttr.merge
- Defined in ucnot/churi/src/schema/meta/single.uc-attr.ts:30

store

store(data, value, meta): T
Stores attribute value to metadata.
Parameters
- data: undefined | T
  
  Already stored attribute data or undefined if nothing stored yet.
- value: T
  
  The input value to store.
- meta: UcMeta
  
  Target metadata to store the value in.
Returns T
Value to store.
Overrides UcMetaAttr.store
- Defined in ucnot/churi/src/schema/meta/single.uc-attr.ts:21

Generated using TypeDoc