TransactionMetadatumLabels overview

Table of contents

• model
  • TransactionMetadatumLabel
  • TransactionMetadatumLabel (type alias)
• schemas
  • TransactionMetadatumLabels (class)
    • toJSON (method)
    • toString (method)
    • [Inspectable.NodeInspectSymbol] (method)
    • [Equal.symbol] (method)
    • [Hash.symbol] (method)
    • size (method)
    • get (method)
    • set (method)
    • add (method)
    • removeFirst (method)
    • removeLast (method)
    • removeAll (method)
    • removeAt (method)
    • has (method)
• utils
  • describeTransactionMetadatumLabel

model

TransactionMetadatumLabel

CDDL spec:

transaction_metadatum_label = uint .size 8

Signature

export declare const TransactionMetadatumLabel: typeof Schema.Uint8

Added in v2.0.0

TransactionMetadatumLabel (type alias)

Type representing a transaction metadatum label.

Signature

export type TransactionMetadatumLabel = typeof TransactionMetadatumLabel.Type

Added in v2.0.0

schemas

TransactionMetadatumLabels (class)

Transaction metadatum labels from an array of TransactionMetadatumLabel

Signature

export declare class TransactionMetadatumLabels

Added in v2.0.0

toJSON (method)

Signature

toJSON()

toString (method)

Signature

toString(): string

[Inspectable.NodeInspectSymbol] (method)

Signature

;[Inspectable.NodeInspectSymbol]()

[Equal.symbol] (method)

Signature

[Equal.symbol](that: unknown): boolean

[Hash.symbol] (method)

Signature

[Hash.symbol](): number

size (method)

Gets the size of the labels.

Signature

size()

get (method)

Gets the label located at the specified index. If the index is out-of-bound, returns undefined

Signature

get(index: number)

set (method)

Overrides the existing labels with the specified ones.

Signature

set(overideLabels: Array<TransactionMetadatumLabel>)

add (method)

Appends a new label to the end

Signature

add(label: TransactionMetadatumLabel)

removeFirst (method)

Removes the first occurence of the specified label from the collection.

Signature

removeFirst(label: TransactionMetadatumLabel)

removeLast (method)

Removes the last occurence of the specified label from the collection.

Signature

removeLast(label: TransactionMetadatumLabel)

removeAll (method)

Removes all occurences of the specified label from the collection.

Signature

removeAll(label: TransactionMetadatumLabel)

removeAt (method)

Removes the label at the specified index from the collection.

Signature

removeAt(index: number)

has (method)

Determines whether the collection contains the specified label.

Signature

has(label: TransactionMetadatumLabel)

utils

describeTransactionMetadatumLabel

Describe transaction metadatum label as per CIP-10 standard.

NOTE: Only labels associated with CIPs will be described.

Signature

export declare const describeTransactionMetadatumLabel: (label: TransactionMetadatumLabel) => string | undefined

Added in v2.0.0