Class PlutusMap

Represents a Map of Plutus data.

Hierarchy

PlutusMap

Index

Constructors

Properties

#map #useIndefiniteEncoding

Methods

equals get getKeys getLength insert toCbor fromCbor

Constructors

constructor

new PlutusMap(): Serialization.PlutusMap
Returns Serialization.PlutusMap

Properties

`Private` `Readonly` #map

#map: Map<Serialization.PlutusData, Serialization.PlutusData> = ...

`Private` #useIndefiniteEncoding

#useIndefiniteEncoding: boolean = false

Methods

equals

equals(other: Serialization.PlutusMap): boolean
Indicates whether some other PlutusMap is "equal to" this one.

Returns
true if objects are equals; otherwise false.
Parameters
- other: Serialization.PlutusMap
  
  The other object to be compared.
Returns boolean
- Defined in packages/core/src/Serialization/PlutusData/PlutusMap.ts:119

get

get(key: Serialization.PlutusData): undefined | Serialization.PlutusData
Returns the specified element from the map.

Returns
The element associated with the specified key in the map, or undefined if there is no element with the given key.
Parameters
- key: Serialization.PlutusData
  
  The key of the element to return from the map.
Returns undefined | Serialization.PlutusData
- Defined in packages/core/src/Serialization/PlutusData/PlutusMap.ts:88

getKeys

getKeys(): Serialization.PlutusList
Gets all the keys from the map as a plutus list.

Returns
The keys of the map as a plutus list.

Returns Serialization.PlutusList
- Defined in packages/core/src/Serialization/PlutusData/PlutusMap.ts:103

getLength

getLength(): number
Gets the length of the map.

Returns
the length of the map.

Returns number
- Defined in packages/core/src/Serialization/PlutusData/PlutusMap.ts:67

insert

insert(key: Serialization.PlutusData, value: Serialization.PlutusData): void
Adds an element to the map.
Parameters
- key: Serialization.PlutusData
  
  The key of the element in the map.
- value: Serialization.PlutusData
  
  The value of the element.
Returns void
- Defined in packages/core/src/Serialization/PlutusData/PlutusMap.ts:77

toCbor

toCbor(): HexBlob
Serializes this PlutusMap instance into its CBOR representation as a Uint8Array.

Returns
The CBOR representation of this instance as a Uint8Array.

Returns HexBlob
- Defined in packages/core/src/Serialization/PlutusData/PlutusMap.ts:17

`Static` fromCbor

fromCbor(cbor: HexBlob): Serialization.PlutusMap
Deserializes a PlutusMap instance from its CBOR representation.

Returns
A PlutusMap instance.
Parameters
- cbor: HexBlob
  
  The CBOR representation of this instance as a Uint8Array.
Returns Serialization.PlutusMap
- Defined in packages/core/src/Serialization/PlutusData/PlutusMap.ts:42

Generated using TypeDoc