Class: CollectionMetadataDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:67

Extends#

• BaseNumberTypeClass<CollectionMetadataDetails<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iCollectionMetadataDetails<T>

Constructors#

Constructor#

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:77

Parameters#

data#

iCollectionMetadataDetails<T>

Returns#

CollectionMetadataDetails<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

customData#

customData: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:74

Custom data

Implementation of#

iCollectionMetadataDetails.customData

---

fetchedUri?#

optional fetchedUri?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:73

The URI that the metadata was fetched from with placeholders replaced.

Implementation of#

iCollectionMetadataDetails.fetchedUri

---

metadata?#

optional metadata?: Metadata<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:71

The metadata fetched by the URI

Implementation of#

iCollectionMetadataDetails.metadata

---

toUploadToIpfs?#

optional toUploadToIpfs?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:75

Flag to denote if the metadata is new and should be updated. Used internally.

Implementation of#

iCollectionMetadataDetails.toUploadToIpfs

---

uri#

uri: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:72

The URI that the metadata was fetched from. This is the original on-chain URI, so may still have placeholders (i.e. {id} or {address})

Implementation of#

iCollectionMetadataDetails.uri

Methods#

clone()#

clone(): CollectionMetadataDetails

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

Deep copies the object and returns a new instance.

Returns#

CollectionMetadataDetails

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:90

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

CollectionMetadataDetails<U>

Overrides#

BaseNumberTypeClass.convert

---

equals()#

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

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

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#

BaseNumberTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:86

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

Returns#

string[]

Overrides#

BaseNumberTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

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

Checks if the object has number fields.

Returns#

boolean

Inherited from#

BaseNumberTypeClass.hasNumberFields

---

toJson()#

toJson(): JsonObject

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

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

Returns#

JsonObject

Inherited from#

BaseNumberTypeClass.toJson

---

toJsonString()#

toJsonString(): string

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

Converts the object to a JSON string.

Returns#

string

Inherited from#

BaseNumberTypeClass.toJsonString

---

toProto()#

toProto(): CollectionMetadata

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:94

Returns#

CollectionMetadata