Class: MerklePathItem

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:640

MerklePathItem is used to represent a merkle path item.

Extends#

• CustomTypeClass<MerklePathItem>

Constructors#

Constructor#

new MerklePathItem(merklePathItem): MerklePathItem

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:644

Parameters#

merklePathItem#

iMerklePathItem

Returns#

MerklePathItem

Overrides#

CustomTypeClass.constructor

Properties#

aunt#

aunt: string

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:641

---

onRight#

onRight: boolean

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:642

Methods#

clone()#

clone(): MerklePathItem

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:661

Deep copies the object and returns a new instance.

Returns#

MerklePathItem

Overrides#

CustomTypeClass.clone

---

convert()#

convert<U>(_convertFunction?, options?): CustomType<any>

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:124

Type Parameters#

U#

U extends NumberType

Parameters#

_convertFunction?#

(val) => U

options?#

ConvertOptions

Returns#

CustomType<any>

Deprecated#

This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.

Inherited from#

CustomTypeClass.convert

---

equals()#

equals<U>(other, normalizeNumberTypes?): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:101

Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").

Type Parameters#

U#

U extends CustomType<U>

Parameters#

other#

CustomType<U> | null | undefined

normalizeNumberTypes?#

boolean

Returns#

boolean

Inherited from#

CustomTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:111

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns#

string[]

Inherited from#

CustomTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:115

Checks if the object has number fields.

Returns#

boolean

Inherited from#

CustomTypeClass.hasNumberFields

---

toJson()#

toJson(): JsonObject

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:93

Converts the object to a JSON object with all primitive types.

Returns#

JsonObject

Inherited from#

CustomTypeClass.toJson

---

toJsonString()#

toJsonString(): string

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:97

Converts the object to a JSON string.

Returns#

string

Inherited from#

CustomTypeClass.toJsonString

---

toProto()#

toProto(): MerklePathItem

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:657

Returns#

MerklePathItem

---

fromJson()#

static fromJson(jsonValue, options?): MerklePathItem

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:665

Parameters#

jsonValue#

JsonValue

options?#

Partial<JsonReadOptions>

Returns#

MerklePathItem

---

fromJsonString()#

static fromJsonString(jsonString, options?): MerklePathItem

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:669

Parameters#

jsonString#

string

options?#

Partial<JsonReadOptions>

Returns#

MerklePathItem

---

fromProto()#

static fromProto(item): MerklePathItem

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:673

Parameters#

item#

MerklePathItem

Returns#

MerklePathItem

---

required()#

static required(): MerklePathItem

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:650

Returns#

MerklePathItem