Class UcMeta

Charge metadata consisting of attributes and their values.

Metadata instance is mutable, unless frozen. When frozen, each modification method call returns new, mutable clone. When mutable, each modification method call returns this instance.

Applies copy-on-write technique to avoid excessive data copying.

Hierarchy

UcMeta
- Mutable
- Frozen

Index

Constructors

constructor

new UcMeta(source?, frozen?): UcMeta
Constructs new metadata instance.
Parameters
- Optional source: UcMeta
  
  Source metadata to clone the contents of.
  
  Optional
- frozen: boolean = false
  
  Whether to freeze constructed metadata. false by default.
Returns UcMeta
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:46

Accessors

`Static` empty

get empty(): Frozen
Metadata instance that is frozen to be empty.

Returns Frozen
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:22

size

get size(): number
The number of attributes this metadata instance contains.

Returns number
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:73

Methods

`Static` create

create(source?): Mutable
Creates new mutable metadata instance.
Parameters
- Optional source: UcMeta
  
  Source metadata to clone the contents of to created metadata.
  
  Optional
Returns Mutable
New mutable metadata instance.
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:33

add

add(attribute, value): Mutable
Adds named attribute value to this metadata.
Parameters
- attribute: string
  
  Target attribute name.
- value: unknown
  
  Value to add.
Returns Mutable
Modified metadata instance containing both attributes of this instance and the added ones.
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:176
add<TInput>(attribute, value): Mutable
Adds typed attribute value to this metadata.
Type Parameters
- TInput
  
  Attribute input type.
Parameters
- attribute: UcMetaAttr<unknown, TInput, unknown>
  
  Target attribute.
- value: TInput
  
  Value to add.
Returns Mutable
Modified metadata instance containing both attributes of this instance and the added ones.
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:187

addAll

addAll(other): Mutable
Adds the given metadata attributes to this metadata.
Parameters
- other: UcMeta
  
  Metadata to add attributes from.
Returns Mutable
Modified metadata instance containing both attributes of this instance and the added ones.
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:249

attributes

attributes(): IterableIterator<UcMetaAttr<unknown, unknown, unknown>>
Iterates over attributes.

Returns IterableIterator<UcMetaAttr<unknown, unknown, unknown>>
Iterable iterator of attributes.
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:162

clone

clone(): Mutable
Creates mutable clone of this metadata.

Returns Mutable
Mutable clone with this metadata contents.
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:276

freeze

freeze(): Frozen
Converts this metadata to frozen one.

Returns Frozen
Either this instance if already frozen, or frozen clone otherwise.
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:285

get

get(attribute): unknown
Obtains the value of the named attribute.

If attribute has multiple values, then returns the last one.
Parameters
- attribute: string
  
  Target attribute name.
Returns unknown
Either attribute value, or undefined if there is no such attribute.
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:95
get<T>(attribute): undefined | T
Extracts the typed value of the attribute.
Type Parameters
- T
  
  Attribute value type.
Parameters
- attribute: UcMetaAttr<T, unknown, unknown>
  
  Target attribute.
Returns undefined | T
Either attribute value, or undefined if attribute value can not be extracted.
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:105

getAll

getAll(attribute): unknown[]
Obtains all values of the named attribute.
Parameters
- attribute: string
  
  Target attribute name.
Returns unknown[]
Either array of attribute values, or empty array if there is no such attribute.
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:131
getAll<T>(attribute): T[]
Extracts all typed values of the attribute.
Type Parameters
- T
  
  Attribute value type.
Parameters
- attribute: UcMetaAttr<T, unknown, unknown>
  
  Target attribute.
Returns T[]
Either array of attribute values, or empty array attribute values can not be extracted.
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:142

has

has(attribute): boolean
Checks whether the given attribute exists within metadata.
Parameters
- attribute: string
  
  Target attribute.
Returns boolean
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:82

isFrozen

isFrozen(): this is Frozen
Informs whether this metadata instance is frozen.

Returns this is Frozen
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:59

isMutable

isMutable(): this is Mutable
Informs whether this metadata instance is mutable.

Returns this is Mutable
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:66

toString

toString(): string
Represents this metadata as string.

Returns string
The encoded metadata.
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:324

toUC

toUC(rx, mode): void
Represents this metadata as charge and transfers it to the given charge receiver.
Parameters
- rx: AllUcrx
  
  Charge receiver.
- mode: UctxMode
  
  Transfer mode.
Returns void
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:312

unfreeze

unfreeze(): Mutable
Converts this metadata to mutable one.

Returns Mutable
Either this instance if already mutable, or mutable clone otherwise.
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:302

Class UcMeta

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Optional source: UcMeta

frozen: boolean = false

Returns UcMeta

Accessors

Static empty

Returns Frozen

size

Returns number

Methods

Static create

Parameters

Optional source: UcMeta

Returns Mutable

add

Parameters

attribute: string

value: unknown

Returns Mutable

Type Parameters

TInput

Parameters

attribute: UcMetaAttr<unknown, TInput, unknown>

value: TInput

Returns Mutable

addAll

Parameters

other: UcMeta

Returns Mutable

attributes

Returns IterableIterator<UcMetaAttr<unknown, unknown, unknown>>

clone

Returns Mutable

freeze

Returns Frozen

get

Parameters

attribute: string

Returns unknown

Type Parameters

T

Parameters

attribute: UcMetaAttr<T, unknown, unknown>

Returns undefined | T

getAll

Parameters

attribute: string

Returns unknown[]

Type Parameters

T

Parameters

attribute: UcMetaAttr<T, unknown, unknown>

Returns T[]

has

Parameters

attribute: string

Returns boolean

isFrozen

Returns this is Frozen

isMutable

Returns this is Mutable

toString

Returns string

toUC

Parameters

rx: AllUcrx

mode: UctxMode

Returns void

unfreeze

Returns Mutable

Settings

Member Visibility

`Optional` source: UcMeta

`Static` empty

`Static` create

`Optional` source: UcMeta