Class: CollectionMetadata

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

CollectionMetadata represents the metadata of the collection

Extends#

• CustomTypeClass<CollectionMetadata>

Implements#

• iCollectionMetadata

Constructors#

Constructor#

new CollectionMetadata(collectionMetadata): CollectionMetadata

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

Parameters#

collectionMetadata#

iCollectionMetadata

Returns#

CollectionMetadata

Overrides#

CustomTypeClass.constructor

Properties#

customData#

customData: string

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

Arbitrary custom data that can be stored on-chain

Implementation of#

iCollectionMetadata.customData

---

uri#

uri: string

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

The URI where to fetch the collection metadata from.

Implementation of#

iCollectionMetadata.uri

Methods#

clone()#

clone(): CollectionMetadata

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

Deep copies the object and returns a new instance.

Returns#

CollectionMetadata

Inherited from#

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(): CollectionMetadata

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

Returns#

CollectionMetadata

---

fromJson()#

static fromJson(jsonValue, options?): CollectionMetadata

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

Parameters#

jsonValue#

JsonValue

options?#

Partial<JsonReadOptions>

Returns#

CollectionMetadata

---

fromJsonString()#

static fromJsonString(jsonString, options?): CollectionMetadata

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

Parameters#

jsonString#

string

options?#

Partial<JsonReadOptions>

Returns#

CollectionMetadata

---

fromProto()#

static fromProto(item): CollectionMetadata

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

Parameters#

item#

CollectionMetadata

Returns#

CollectionMetadata