Class: Voter<T>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1361

Voter defines a voter with their address and weight.

Extends#

• BaseNumberTypeClass<Voter<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iVoter<T>

Constructors#

Constructor#

new Voter<T>(voter): Voter<T>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1365

Parameters#

voter#

iVoter<T>

Returns#

Voter<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

address#

address: string

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1362

The address of the voter.

Implementation of#

iVoter.address

---

weight#

weight: T

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1363

The weight of this voter's vote.

Implementation of#

iVoter.weight

Methods#

clone()#

clone(): Voter

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

Deep copies the object and returns a new instance.

Returns#

Voter

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1375

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

Voter<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/core/misc.ts:1371

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

---

fromProto()#

static fromProto<U>(item, convertFunction): Voter<U>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1379

Type Parameters#

U#

U extends NumberType

Parameters#

item#

Voter

convertFunction#

(item) => U

Returns#

Voter<U>