Class: PathMetadataWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/ibc-wrappers.ts:249

PathMetadataWithDetails represents the metadata for paths with fetched metadata details.

Extends#

• PathMetadata

Type Parameters#

T#

T extends NumberType

Implements#

• iPathMetadataWithDetails<T>

Constructors#

Constructor#

new PathMetadataWithDetails<T>(pathMetadata): PathMetadataWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/ibc-wrappers.ts:252

Parameters#

pathMetadata#

iPathMetadataWithDetails<T>

Returns#

PathMetadataWithDetails<T>

Overrides#

PathMetadata.constructor

Properties#

customData#

customData: string

Defined in: packages/bitbadgesjs-sdk/src/core/ibc-wrappers.ts:213

Custom data or additional information related to the path metadata.

Implementation of#

iPathMetadataWithDetails.customData

Inherited from#

PathMetadata.customData

---

metadata?#

optional metadata?: Metadata<T>

Defined in: packages/bitbadgesjs-sdk/src/core/ibc-wrappers.ts:250

The fetched metadata from the URI.

Implementation of#

iPathMetadataWithDetails.metadata

---

uri#

uri: string

Defined in: packages/bitbadgesjs-sdk/src/core/ibc-wrappers.ts:212

The URI (Uniform Resource Identifier) associated with the path metadata.

Implementation of#

iPathMetadataWithDetails.uri

Inherited from#

PathMetadata.uri

Methods#

clone()#

clone(): PathMetadata

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

Deep copies the object and returns a new instance.

Returns#

PathMetadata

Inherited from#

PathMetadata.clone

---

convert()#

convert<U>(convertFunction, options?): PathMetadataWithDetails<U>

Defined in: packages/bitbadgesjs-sdk/src/core/ibc-wrappers.ts:257

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

PathMetadataWithDetails<U>

Deprecated#

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

Overrides#

PathMetadata.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#

PathMetadata.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#

PathMetadata.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#

PathMetadata.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#

PathMetadata.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#

PathMetadata.toJsonString

---

toProto()#

toProto(): PathMetadata

Defined in: packages/bitbadgesjs-sdk/src/core/ibc-wrappers.ts:221

Returns#

PathMetadata

Inherited from#

PathMetadata.toProto

---

fromJson()#

static fromJson(jsonValue, options?): PathMetadata

Defined in: packages/bitbadgesjs-sdk/src/core/ibc-wrappers.ts:228

Parameters#

jsonValue#

JsonValue

options?#

Partial<JsonReadOptions>

Returns#

PathMetadata

Inherited from#

PathMetadata.fromJson

---

fromJsonString()#

static fromJsonString(jsonString, options?): PathMetadata

Defined in: packages/bitbadgesjs-sdk/src/core/ibc-wrappers.ts:232

Parameters#

jsonString#

string

options?#

Partial<JsonReadOptions>

Returns#

PathMetadata

Inherited from#

PathMetadata.fromJsonString

---

fromProto()#

static fromProto(item): PathMetadata

Defined in: packages/bitbadgesjs-sdk/src/core/ibc-wrappers.ts:236

Parameters#

item#

PathMetadata

Returns#

PathMetadata

Inherited from#

PathMetadata.fromProto