Class: UintRange<T>

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:17

UintRange represents a range of numbers from some start ID to some end ID, inclusive.

See https://docs.bitbadges.io/for-developers/core-concepts/uint-ranges for more information.

Extends#

• BaseNumberTypeClass<UintRange<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iUintRange<T>

Constructors#

Constructor#

new UintRange<T>(uintRange): UintRange<T>

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:21

Parameters#

uintRange#

iUintRange<T>

Returns#

UintRange<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

end#

end: T

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:19

The end of the range, inclusive.

Implementation of#

iUintRange.end

---

start#

start: T

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:18

The start of the range.

Implementation of#

iUintRange.start

Methods#

clone()#

clone(): UintRange

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

Deep copies the object and returns a new instance.

Returns#

UintRange

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:31

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

UintRange<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/uintRanges.ts:27

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns#

string[]

Overrides#

BaseNumberTypeClass.getNumberFieldNames

---

getOverlapDetails()#

getOverlapDetails(toCheck): [UintRangeArray<T>, UintRangeArray<T>]

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:148

Returns the [inCurrentButNotInToCheck, overlaps].

Parameters#

toCheck#

iUintRange<T> | iUintRange<T>[] | UintRangeArray<T>

Returns#

[UintRangeArray<T>, UintRangeArray<T>]

---

getOverlaps()#

getOverlaps(toRemove): UintRangeArray<T>

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:221

Returns the overlap between the current range and the provided range.

Parameters#

toRemove#

iUintRange<T> | iUintRange<T>[] | UintRangeArray<T>

Returns#

UintRangeArray<T>

---

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

---

invert()#

invert(minId?, maxId?): UintRangeArray<T>

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:124

Returns a new UintRangeArray that is the result of inverting the current range (i.e. getting all values within the bounds that are not in the current range).

Parameters#

minId?#

NumberType = 1n

maxId?#

NumberType = GO_MAX_UINT_64

Returns#

UintRangeArray<T>

---

isFull()#

isFull(): boolean

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:80

Returns true if the range is full (i.e. start = 1 and end = 18446744073709551615).

This is considered full in the context of token IDs and times.

Returns#

boolean

---

overlaps()#

overlaps(other): boolean

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:111

Returns true if the range overlaps with the other range.

Parameters#

other#

iUintRange<T> | iUintRange<T>[] | UintRangeArray<T>

Returns#

boolean

---

search()#

search(id): boolean

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:134

Searches for a specific ID within the range.

Parameters#

id#

NumberType

Returns#

boolean

---

size()#

size(): T

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:70

Returns the size of the range (i.e. end - start + 1).

Returns#

T

---

toArray()#

toArray(): UintRangeArray<T>

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:225

Returns#

UintRangeArray<T>

---

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

---

toProto()#

toProto(): UintRange

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:40

Returns#

UintRange

---

createUintRange()#

protected static createUintRange<T>(start, end): UintRange<T>

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:138

Type Parameters#

T#

T extends NumberType

Parameters#

start#

T

end#

T

Returns#

UintRange<T>

---

From()#

static From<T>(val): UintRange<T>

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:101

Type Parameters#

T#

T extends NumberType

Parameters#

val#

T

Returns#

UintRange<T>

---

fromJson()#

static fromJson<U>(jsonValue, convertFunction, options?): UintRange<U>

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:44

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

UintRange<U>

---

fromJsonString()#

static fromJsonString<U>(jsonString, convertFunction, options?): UintRange<U>

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:52

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

UintRange<U>

---

fromProto()#

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

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:60

Type Parameters#

U#

U extends NumberType

Parameters#

item#

UintRange

convertFunction#

(item) => U

Returns#

UintRange<U>

---

FullRange()#

static FullRange(): UintRange<bigint>

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:87

Returns a new UintRange from 1 to 18446744073709551615 (max uint64).

Returns#

UintRange<bigint>

---

FullRanges()#

static FullRanges(): UintRangeArray<bigint>

Defined in: packages/bitbadgesjs-sdk/src/core/uintRanges.ts:97

Returns a new UintRangeArray from 1 to 18446744073709551615 (max uint64).

Returns#

UintRangeArray<bigint>