Class: UtilityPageLink<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1171

Extends#

• CustomTypeClass<UtilityPageLink<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iUtilityPageLink<T>

Constructors#

Constructor#

new UtilityPageLink<T>(data): UtilityPageLink<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1179

Parameters#

data#

iUtilityPageLink<T>

Returns#

UtilityPageLink<T>

Overrides#

CustomTypeClass.constructor

Properties#

applicationId?#

optional applicationId?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1174

The application ID to link to

Implementation of#

iUtilityPageLink.applicationId

---

claimId?#

optional claimId?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1173

The claim ID to link to

Implementation of#

iUtilityPageLink.claimId

---

collectionId?#

optional collectionId?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1175

The collection ID to link to

Implementation of#

iUtilityPageLink.collectionId

---

mapId?#

optional mapId?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1176

The map ID to link to

Implementation of#

iUtilityPageLink.mapId

---

metadata?#

optional metadata?: iMetadata<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1177

Metadata for the link. Only applicable if the link is to a non-BitBadges entity. In other words, not tied to a specific claim, application, collection, etc.

Implementation of#

iUtilityPageLink.metadata

---

url#

url: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1172

The URL of the link

Implementation of#

iUtilityPageLink.url

Methods#

clone()#

clone(): UtilityPageLink

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

Deep copies the object and returns a new instance.

Returns#

UtilityPageLink

Inherited from#

CustomTypeClass.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1193

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

UtilityPageLink<U>

Deprecated#

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

Overrides#

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/api-indexer/docs-types/docs.ts:1189

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

Returns#

string[]

Overrides#

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