Class UcMetaAttr<T, TInput, TData>`Abstract`

Typed attribute of charge metadata.

When used as attribute key, the methods of attribute applied to store and extract attribute value(s).

Type Parameters

out T = unknown

Attribute value type.
in TInput = unknown

Attribute input type.

Accepted when attribute value added to metadata.

May differ from actual attribute value type.
out TData = unknown

Stored data type.

Declares what actually stored inside metadata.

Hierarchy

UcMetaAttr
- SingleUcAttr
- UcAttr

Index

Constructors

Accessors

Methods

charge clone extract extractAll merge store

Constructors

constructor

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

Accessors

name

get name(): string
Attribute name.

Returns string
- 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
- 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: TData
  
  Stored attribute data.
- meta: UcMeta
  
  Source metadata.
Returns void
- Defined in ucnot/churi/src/schema/meta/uc-meta-attr.ts:115

`Abstract` clone

clone(data): TData
Clones attribute data.

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

`Abstract` extract

extract(data, meta): undefined | T
Extracts attribute value from metadata.
Parameters
- data: undefined | TData
  
  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.
- Defined in ucnot/churi/src/schema/meta/uc-meta-attr.ts:60

`Abstract` extractAll

extractAll(data, meta): T[]
Extracts all attribute values.
Parameters
- data: undefined | TData
  
  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.
- Defined in ucnot/churi/src/schema/meta/uc-meta-attr.ts:70

`Abstract` merge

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

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

`Abstract` store

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

Generated using TypeDoc