Class CollectionMetadataDetails<T>

Type Parameters

T extends NumberType

Hierarchy (view full)

BaseNumberTypeClass<CollectionMetadataDetails<T>>
- CollectionMetadataDetails

Implements

iCollectionMetadataDetails<T>

Index

Constructors

Properties

customData fetchedUri? metadata? toUploadToIpfs? uri

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString toProto

Constructors

constructor

new CollectionMetadataDetails<T>(data): CollectionMetadataDetails<T>
Type Parameters
- T extends NumberType
Parameters
- data: iCollectionMetadataDetails<T>
Returns CollectionMetadataDetails<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/api-indexer/metadata/badgeMetadata.ts:77

Properties

customData

customData: string

Custom data

`Optional`fetchedUri

fetchedUri?: string

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

`Optional`metadata

metadata?: Metadata<T>

The metadata fetched by the URI

`Optional`toUploadToIpfs

toUploadToIpfs?: boolean

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

uri

uri: string

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})

Methods

clone

clone(): CollectionMetadataDetails<T>
Deep copies the object and returns a new instance.

Returns CollectionMetadataDetails<T>
Inherited from BaseNumberTypeClass.clone
- Defined in src/common/base.ts:121

convert

convert<U>(convertFunction, options?): CollectionMetadataDetails<U>
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item: NumberType) => U)
  - - (item): U
    - Parameters
      item: NumberType
      Returns U
- Optionaloptions: ConvertOptions
Returns CollectionMetadataDetails<U>
Overrides BaseNumberTypeClass.convert
- Defined in src/api-indexer/metadata/badgeMetadata.ts:90

equals

equals<U>(other, normalizeNumberTypes?): boolean
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 extends CustomType<U>
Parameters
- other: undefined | null | CustomType<U>
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Inherited from BaseNumberTypeClass.equals
- Defined in src/common/base.ts:117

getNumberFieldNames

getNumberFieldNames(): string[]
Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns string[]
Overrides BaseNumberTypeClass.getNumberFieldNames
- Defined in src/api-indexer/metadata/badgeMetadata.ts:86

hasNumberFields

hasNumberFields(): boolean
Checks if the object has number fields.

Returns boolean
Inherited from BaseNumberTypeClass.hasNumberFields
- Defined in src/common/base.ts:131

toJson

toJson(): JsonObject
Converts the object to a JSON object with all primitive types.

Returns JsonObject
Inherited from BaseNumberTypeClass.toJson
- Defined in src/common/base.ts:109

toJsonString

toJsonString(): string
Converts the object to a JSON string.

Returns string
Inherited from BaseNumberTypeClass.toJsonString
- Defined in src/common/base.ts:113

toProto

toProto(): proto.badges.CollectionMetadata
Returns proto.badges.CollectionMetadata
- Defined in src/api-indexer/metadata/badgeMetadata.ts:94