# Class: TokenMetadata\ Defined in: [packages/bitbadgesjs-sdk/src/core/misc.ts:72](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/core/misc.ts#L72) TokenMetadata is used to represent the metadata for a range of token IDs. The metadata can be hosted via a URI (via uri) or stored on-chain (via customData). We take first-match only for the token IDs. If a token ID is in multiple TokenMetadata, we take the first match in a linear search. ## Extends - [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class)\<`TokenMetadata`\<`T`\>\> ## Type Parameters ### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) ## Implements - [`iTokenMetadata`](https://docs.bitbadges.io/sdk/reference/interfaces/i-token-metadata)\<`T`\> ## Constructors ### Constructor > **new TokenMetadata**\<`T`\>(`tokenMetadata`): `TokenMetadata`\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/core/misc.ts:77](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/core/misc.ts#L77) #### Parameters ##### tokenMetadata [`iTokenMetadata`](https://docs.bitbadges.io/sdk/reference/interfaces/i-token-metadata)\<`T`\> #### Returns `TokenMetadata`\<`T`\> #### Overrides [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`constructor`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#constructor) ## Properties ### customData > **customData**: `string` Defined in: [packages/bitbadgesjs-sdk/src/core/misc.ts:75](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/core/misc.ts#L75) Arbitrary custom data that can be stored on-chain #### Implementation of [`iTokenMetadata`](https://docs.bitbadges.io/sdk/reference/interfaces/i-token-metadata).[`customData`](https://docs.bitbadges.io/sdk/reference/interfaces/i-token-metadata#customdata) *** ### tokenIds > **tokenIds**: [`UintRangeArray`](https://docs.bitbadges.io/sdk/reference/classes/uint-range-array)\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/core/misc.ts:74](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/core/misc.ts#L74) The token IDs corresponding to the URI. #### Implementation of [`iTokenMetadata`](https://docs.bitbadges.io/sdk/reference/interfaces/i-token-metadata).[`tokenIds`](https://docs.bitbadges.io/sdk/reference/interfaces/i-token-metadata#tokenids) *** ### uri > **uri**: `string` Defined in: [packages/bitbadgesjs-sdk/src/core/misc.ts:73](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/core/misc.ts#L73) The URI where to fetch the token metadata from. #### Implementation of [`iTokenMetadata`](https://docs.bitbadges.io/sdk/reference/interfaces/i-token-metadata).[`uri`](https://docs.bitbadges.io/sdk/reference/interfaces/i-token-metadata#uri) ## Methods ### clone() > **clone**(): `TokenMetadata` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:151](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L151) Deep copies the object and returns a new instance. #### Returns `TokenMetadata` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`clone`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#clone) *** ### convert() > **convert**\<`U`\>(`convertFunction`, `options?`): `TokenMetadata`\<`U`\> Defined in: [packages/bitbadgesjs-sdk/src/core/misc.ts:84](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/core/misc.ts#L84) Converts the object to a different NumberType equivalent. #### Type Parameters ##### U `U` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### convertFunction (`item`) => `U` ##### options? [`ConvertOptions`](https://docs.bitbadges.io/sdk/reference/interfaces/convert-options) #### Returns `TokenMetadata`\<`U`\> #### Overrides [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`convert`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#convert) *** ### equals() > **equals**\<`U`\>(`other`, `normalizeNumberTypes?`): `boolean` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:147](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L147) 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`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`U`\> #### Parameters ##### other [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`U`\> \| `null` \| `undefined` ##### normalizeNumberTypes? `boolean` #### Returns `boolean` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`equals`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#equals) *** ### getNumberFieldNames() > **getNumberFieldNames**(): `string`[] Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:157](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L157) Internal helper method to convert the number fields of the object to a different NumberType equivalent. #### Returns `string`[] #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`getNumberFieldNames`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#getnumberfieldnames) *** ### hasNumberFields() > **hasNumberFields**(): `boolean` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:161](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L161) Checks if the object has number fields. #### Returns `boolean` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`hasNumberFields`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#hasnumberfields) *** ### toJson() > **toJson**(): `JsonObject` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:139](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L139) Converts the object to a JSON object with all primitive types. #### Returns `JsonObject` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`toJson`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#tojson) *** ### toJsonString() > **toJsonString**(): `string` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:143](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L143) Converts the object to a JSON string. #### Returns `string` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`toJsonString`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#tojsonstring) *** ### toProto() > **toProto**(): `TokenMetadata` Defined in: [packages/bitbadgesjs-sdk/src/core/misc.ts:94](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/core/misc.ts#L94) #### Returns `TokenMetadata` *** ### fromJson() > `static` **fromJson**\<`U`\>(`jsonValue`, `convertFunction`, `options?`): `TokenMetadata`\<`U`\> Defined in: [packages/bitbadgesjs-sdk/src/core/misc.ts:102](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/core/misc.ts#L102) #### Type Parameters ##### U `U` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### jsonValue `JsonValue` ##### convertFunction (`item`) => `U` ##### options? `Partial`\<`JsonReadOptions`\> #### Returns `TokenMetadata`\<`U`\> *** ### fromJsonString() > `static` **fromJsonString**\<`U`\>(`jsonString`, `convertFunction`, `options?`): `TokenMetadata`\<`U`\> Defined in: [packages/bitbadgesjs-sdk/src/core/misc.ts:110](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/core/misc.ts#L110) #### Type Parameters ##### U `U` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### jsonString `string` ##### convertFunction (`item`) => `U` ##### options? `Partial`\<`JsonReadOptions`\> #### Returns `TokenMetadata`\<`U`\> *** ### fromProto() > `static` **fromProto**\<`U`\>(`item`, `convertFunction`): `TokenMetadata`\<`U`\> Defined in: [packages/bitbadgesjs-sdk/src/core/misc.ts:118](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/core/misc.ts#L118) #### Type Parameters ##### U `U` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### item `TokenMetadata` ##### convertFunction (`item`) => `U` #### Returns `TokenMetadata`\<`U`\> *** ### getFirstMatches() > `static` **getFirstMatches**\<`T`\>(`tokenMetadata`): `TokenMetadata`\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/core/misc.ts:129](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/core/misc.ts#L129) Get first matches for the token metadata (i.e. if there are duplicated token IDs, we take the first match in a linear search). #### Type Parameters ##### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### tokenMetadata `TokenMetadata`\<`T`\>[] #### Returns `TokenMetadata`\<`T`\>[]