Class: TierWithOptionalWeight<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1087

Extends#

• BaseNumberTypeClass<TierWithOptionalWeight<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iTierWithOptionalWeight<T>

Constructors#

Constructor#

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1096

Parameters#

data#

iTierWithOptionalWeight<T>

Returns#

TierWithOptionalWeight<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

claimId#

claimId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1091

The claim ID to satisfy the tier

Implementation of#

iTierWithOptionalWeight.claimId

---

pointsCalculationMethod?#

optional pointsCalculationMethod?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1094

The calculation method to use for this tier. This is used for calculating the tier weight.

By default, we check if the user has met the criteria for non-indexed and for indexed, we check claimed successfully at least one time.

Implementation of#

iTierWithOptionalWeight.pointsCalculationMethod

---

uncheckable?#

optional uncheckable?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1093

Uncheckable? If so, we will not display success or failure for this tier.

We will just display the claim criteria and metadata.

Implementation of#

iTierWithOptionalWeight.uncheckable

---

weight?#

optional weight?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1092

The weight of the tier

Implementation of#

iTierWithOptionalWeight.weight

Methods#

clone()#

clone(): TierWithOptionalWeight

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

Deep copies the object and returns a new instance.

Returns#

TierWithOptionalWeight

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1108

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

TierWithOptionalWeight<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/docs-types/docs.ts:1104

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