Class: Metadata<T>

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

Extends#

• BaseNumberTypeClass<Metadata<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iMetadata<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iMetadata<T>

Returns#

Metadata<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

_isUpdating?#

optional _isUpdating?: boolean

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

Whether the metadata is currently being updated.

Implementation of#

iMetadata._isUpdating

additionalInfo?#

optional additionalInfo?: object[]

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

Header links for this item displayed right under the title

description#

description: string

image#

image: string

name#

name: string

url?#

optional url?: string

Implementation of#

iMetadata.additionalInfo

attributes?#

optional attributes?: object[]

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

The attributes for this item

name#

name: string

type#

type: string

value#

value: string | number | boolean

Implementation of#

iMetadata.attributes

bannerImage?#

optional bannerImage?: string

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

The banner image for this item.

Implementation of#

iMetadata.bannerImage

category?#

optional category?: string

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

The category for this item (e.g. "Education", "Attendance").

Implementation of#

iMetadata.category

description#

description: string

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

The description of this item. Supports markdown.

Implementation of#

iMetadata.description

externalUrl?#

optional externalUrl?: string

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

The external URL for this item.

Implementation of#

iMetadata.externalUrl

fetchedAt?#

optional fetchedAt?: T

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

The time the metadata was fetched.

Implementation of#

iMetadata.fetchedAt

fetchedAtBlock?#

optional fetchedAtBlock?: T

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

The block the metadata was fetched at.

Implementation of#

iMetadata.fetchedAtBlock

image#

image: string

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

The image for this item.

Implementation of#

iMetadata.image

name#

name: string

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

The name of this item.

Implementation of#

iMetadata.name

socials?#

optional socials?: object

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

The socials for this item

Index Signature#

[key: string]: string

Implementation of#

iMetadata.socials

tags?#

optional tags?: string[]

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

The tags for this item

Implementation of#

iMetadata.tags

Methods#

clone()#

clone(): Metadata

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

Deep copies the object and returns a new instance.

Returns#

Metadata

Inherited from#

BaseNumberTypeClass.clone

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

Metadata<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/metadata.ts:120

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

DefaultPlaceholderMetadata()#

static DefaultPlaceholderMetadata(): Metadata<bigint>

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

Returns a new Metadata object with default placeholder values. By default, it returns as <bigint> type, but you can convert it with .convert method.

import { Numberify } from 'bitbadges'
const metadata = Metadata.DefaultPlaceholderMetadata().convert(Numberify)

Returns#

Metadata<bigint>

ErrorMetadata()#

static ErrorMetadata(): Metadata<bigint>

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

Returns a new Metadata object with default placeholder values. By default, it returns as <bigint> type, but you can convert it with .convert method.

import { Numberify } from 'bitbadges'
const metadata = Metadata.ErrorMetadata().convert(Numberify)

Returns#

Metadata<bigint>