Class CollectionMetadata

CollectionMetadata represents the metadata of the collection

Hierarchy (View Summary, Expand)

CustomTypeClass<CollectionMetadata>
- CollectionMetadata

Implements

iCollectionMetadata

Index

Constructors

Properties

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString toProto fromJson fromJsonString fromProto

Constructors

constructor

new CollectionMetadata(
collectionMetadata: iCollectionMetadata,
): CollectionMetadata
Parameters
- collectionMetadata: iCollectionMetadata
Returns CollectionMetadata
Overrides CustomTypeClass.constructor
- Defined in src/core/misc.ts:128

Properties

customData

customData: string

Arbitrary custom data that can be stored on-chain

uri

uri: string

The URI where to fetch the collection metadata from.

Methods

clone

clone(): CollectionMetadata
Deep copies the object and returns a new instance.

Returns CollectionMetadata
Inherited from CustomTypeClass.clone
- Defined in src/common/base.ts:105

convert

convert<U extends NumberType>(
_convertFunction?: (val: NumberType) => U,
options?: ConvertOptions,
): CustomType<any>
Type Parameters
- U extends NumberType
Parameters
- Optional_convertFunction: (val: NumberType) => U
- Optionaloptions: 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
- Defined in src/common/base.ts:124

equals

equals<U extends CustomType<U>>(
other: undefined | null | CustomType<U>,
normalizeNumberTypes?: boolean,
): 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 CustomTypeClass.equals
- Defined in src/common/base.ts:101

getNumberFieldNames

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

Returns string[]
Inherited from CustomTypeClass.getNumberFieldNames
- Defined in src/common/base.ts:111

hasNumberFields

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

Returns boolean
Inherited from CustomTypeClass.hasNumberFields
- Defined in src/common/base.ts:115

toJson

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

Returns JsonObject
Inherited from CustomTypeClass.toJson
- Defined in src/common/base.ts:93

toJsonString

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

Returns string
Inherited from CustomTypeClass.toJsonString
- Defined in src/common/base.ts:97

toProto

toProto(): proto.badges.CollectionMetadata
Returns proto.badges.CollectionMetadata
- Defined in src/core/misc.ts:134

`Static`fromJson

fromJson(
jsonValue: JsonValue,
options?: Partial<JsonReadOptions>,
): CollectionMetadata
Parameters
- jsonValue: JsonValue
- Optionaloptions: Partial<JsonReadOptions>
Returns CollectionMetadata
- Defined in src/core/misc.ts:141

`Static`fromJsonString

fromJsonString(
jsonString: string,
options?: Partial<JsonReadOptions>,
): CollectionMetadata
Parameters
- jsonString: string
- Optionaloptions: Partial<JsonReadOptions>
Returns CollectionMetadata
- Defined in src/core/misc.ts:145

`Static`fromProto

fromProto(item: proto.badges.CollectionMetadata): CollectionMetadata
Parameters
- item: proto.badges.CollectionMetadata
Returns CollectionMetadata
- Defined in src/core/misc.ts:149