Class Metadata<T>

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_isUpdating? attributes? category? description externalUrl? fetchedAt? fetchedAtBlock? image name offChainTransferabilityInfo? socials? tags? video?

Methods

clone convert equals getNumberFieldNames toJson toJsonString DefaultPlaceholderMetadata ErrorMetadata

Constructors

constructor

Properties

Optional _isUpdating

_isUpdating?: boolean

Whether the metadata is currently being updated.

Optional attributes

attributes?: {
    name: string;
    type?: "url" | "date";
    value: string | number | boolean;
}[]

The attributes of the badge or badge collection

Type declaration

  • name: string
  • Optional type?: "url" | "date"
  • value: string | number | boolean

Optional category

category?: string

The category of the badge or badge collection (e.g. "Education", "Attendance").

description

description: string

The description of the badge or badge collection. Supports markdown.

Optional externalUrl

externalUrl?: string

The external URL of the badge or badge collection.

Optional fetchedAt

fetchedAt?: T

The time the metadata was fetched.

Optional fetchedAtBlock

fetchedAtBlock?: T

The block the metadata was fetched at.

image

image: string

The image of the badge or badge collection.

name

name: string

The name of the badge or badge collection.

Optional offChainTransferabilityInfo

offChainTransferabilityInfo?: {
    assignMethod: string;
    host: string;
}

The off-chain transferability info of the badge or badge collection

Type declaration

  • assignMethod: string
  • host: string

Optional socials

socials?: {
    [key: string]: string;
}

The socials of the badge or badge collection

Type declaration

  • [key: string]: string

Optional tags

tags?: string[]

The tags of the badge or badge collection

Optional video

video?: string

The video of the badge or badge collection. If a standard video is used, this should be a link to the video. We will use image as the poster image. If a youtube video is used, we embed it as an iframe.

Methods

clone

convert

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

    Parameters

    • other: undefined | null | CustomType<U>
    • Optional normalizeNumberTypes: boolean

    Returns boolean

getNumberFieldNames

toJson

toJsonString

Static DefaultPlaceholderMetadata

  • DefaultPlaceholderMetadata(): Metadata<bigint>

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

    import { Numberify } from 'bitbadgesjs-sdk'
    const metadata = Metadata.DefaultPlaceholderMetadata().convert(Numberify)

    Returns Metadata<bigint>

Static ErrorMetadata

  • ErrorMetadata(): Metadata<bigint>

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

    import { Numberify } from 'bitbadgesjs-sdk'
    const metadata = Metadata.ErrorMetadata().convert(Numberify)

    Returns Metadata<bigint>

Settings

Member Visibility

Theme

On This Page

constructor_isUpdatingattributescategorydescriptionexternalUrlfetchedAtfetchedAtBlockimagenameoffChainTransferabilityInfosocialstagsvideocloneconvertequalsgetNumberFieldNamestoJsontoJsonStringDefaultPlaceholderMetadataErrorMetadata