Interface Frozen

Frozen (immutable) charge metadata instance.

Hierarchy

UcMeta
- Frozen

Index

Accessors

size

Methods

add addAll attributes clone freeze get getAll has isFrozen isMutable toString toUC unfreeze

Accessors

size

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

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

Methods

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.
Inherited from UcMeta.add
- 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.
Inherited from UcMeta.add
- 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.
Inherited from UcMeta.addAll
- 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.
Inherited from UcMeta.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.
Inherited from UcMeta.clone
- 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.
Overrides UcMeta.freeze
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:350

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.
Inherited from UcMeta.get
- 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.
Inherited from UcMeta.get
- 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.
Inherited from UcMeta.getAll
- 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.
Inherited from UcMeta.getAll
- 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
Inherited from UcMeta.has
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:82

isFrozen

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

Returns true
Overrides UcMeta.isFrozen
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:349

isMutable

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

Returns false
Overrides UcMeta.isMutable
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:348

toString

toString(): string
Represents this metadata as string.

Returns string
The encoded metadata.
Inherited from UcMeta.toString
- 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
Inherited from UcMeta.toUC
- 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.
Inherited from UcMeta.unfreeze
- Defined in ucnot/churi/src/schema/meta/uc-meta.ts:302

Interface Frozen

Hierarchy

Index

Accessors

Methods

Accessors

size

Returns number

Methods

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 true

isMutable

Returns false

toString

Returns string

toUC

Parameters

rx: AllUcrx

mode: UctxMode

Returns void

unfreeze

Returns Mutable

Settings

Member Visibility

Theme

On This Page