Class UintRange<T>

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.

Index

Constructors

constructor

new UintRange<T>(uintRange): UintRange<T>
Type Parameters
- T extends NumberType
Parameters
- uintRange: iUintRange<T>
Returns UintRange<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/core/uintRanges.ts:21

Properties

end

end: T

The end of the range, inclusive.

start

start: T

The start of the range.

Methods

clone

clone(): UintRange<T>
Deep copies the object and returns a new instance.

Returns UintRange<T>
Inherited from BaseNumberTypeClass.clone
- Defined in src/common/base.ts:121

convert

convert(convertFunction, options?): UintRange
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optionaloptions: ConvertOptions
Returns UintRange
Overrides BaseNumberTypeClass.convert
- Defined in src/core/uintRanges.ts:31

equals

equals(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
- U extends CustomType
Parameters
- other: undefined | null | CustomType
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Inherited from BaseNumberTypeClass.equals
- Defined in src/common/base.ts:117

getNumberFieldNames

getNumberFieldNames(): string[]
Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns string[]
Overrides BaseNumberTypeClass.getNumberFieldNames
- Defined in src/core/uintRanges.ts:27

getOverlapDetails

getOverlapDetails(toCheck): [UintRangeArray<T>, UintRangeArray<T>]
Returns the [inCurrentButNotInToCheck, overlaps].
Parameters
- toCheck: iUintRange<T> | iUintRange<T>[] | UintRangeArray<T>
Returns [UintRangeArray<T>, UintRangeArray<T>]
- Defined in src/core/uintRanges.ts:148

getOverlaps

getOverlaps(toRemove): UintRangeArray<T>
Returns the overlap between the current range and the provided range.
Parameters
- toRemove: iUintRange<T> | iUintRange<T>[] | UintRangeArray<T>
Returns UintRangeArray<T>
- Defined in src/core/uintRanges.ts:221

hasNumberFields

hasNumberFields(): boolean
Checks if the object has number fields.

Returns boolean
Inherited from BaseNumberTypeClass.hasNumberFields
- Defined in src/common/base.ts:131

invert

invert(minId?, maxId?): UintRangeArray<T>
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 = ...
- maxId: NumberType = GO_MAX_UINT_64
Returns UintRangeArray<T>
- Defined in src/core/uintRanges.ts:124

isFull

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

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

Returns boolean
- Defined in src/core/uintRanges.ts:80

overlaps

overlaps(other): boolean
Returns true if the range overlaps with the other range.
Parameters
- other: iUintRange<T> | iUintRange<T>[] | UintRangeArray<T>
Returns boolean
- Defined in src/core/uintRanges.ts:111

search

search(id): boolean
Searches for a specific ID within the range.
Parameters
- id: NumberType
Returns boolean
- Defined in src/core/uintRanges.ts:134

size

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

Returns T
- Defined in src/core/uintRanges.ts:70

toArray

toArray(): UintRangeArray<T>
Returns UintRangeArray<T>
- Defined in src/core/uintRanges.ts:225

toJson

toJson(): JsonObject
Converts the object to a JSON object with all primitive types.

Returns JsonObject
Inherited from BaseNumberTypeClass.toJson
- Defined in src/common/base.ts:109

toJsonString

toJsonString(): string
Converts the object to a JSON string.

Returns string
Inherited from BaseNumberTypeClass.toJsonString
- Defined in src/common/base.ts:113

toProto

toProto(): proto.badges.UintRange
Returns proto.badges.UintRange
- Defined in src/core/uintRanges.ts:40

`Static`From

From<T>(val): UintRange<T>
Type Parameters
- T extends NumberType
Parameters
- val: T
Returns UintRange<T>
- Defined in src/core/uintRanges.ts:101

`Static`FullRange

FullRange(): UintRange<bigint>
Returns a new UintRange from 1 to 18446744073709551615 (max uint64).

Returns UintRange<bigint>
- Defined in src/core/uintRanges.ts:87

`Static`FullRanges

FullRanges(): UintRangeArray<bigint>
Returns a new UintRangeArray from 1 to 18446744073709551615 (max uint64).

Returns UintRangeArray<bigint>
- Defined in src/core/uintRanges.ts:97

`Protected` `Static`createUintRange

createUintRange<T>(start, end): UintRange<T>
Type Parameters
- T extends NumberType
Parameters
- start: T
- end: T
Returns UintRange<T>
- Defined in src/core/uintRanges.ts:138

`Static`fromJson

fromJson(jsonValue, convertFunction, options?): UintRange
Type Parameters
- U extends NumberType
Parameters
- jsonValue: JsonValue
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optionaloptions: Partial<JsonReadOptions>
Returns UintRange
- Defined in src/core/uintRanges.ts:44

`Static`fromJsonString

fromJsonString(jsonString, convertFunction, options?): UintRange
Type Parameters
- U extends NumberType
Parameters
- jsonString: string
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optionaloptions: Partial<JsonReadOptions>
Returns UintRange
- Defined in src/core/uintRanges.ts:52

`Static`fromProto

fromProto(item, convertFunction): UintRange
Type Parameters
- U extends NumberType
Parameters
- item: proto.badges.UintRange
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
Returns UintRange
- Defined in src/core/uintRanges.ts:60

Class UintRange<T>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UintRange<T>

Properties

end

start

Methods

clone

Returns UintRange<T>

convert

Type Parameters

Parameters

Parameters

Returns U

Returns UintRange<U>

equals

Type Parameters

Parameters

Returns boolean

getNumberFieldNames

Returns string[]

getOverlapDetails

Parameters

Returns [UintRangeArray<T>, UintRangeArray<T>]

getOverlaps

Parameters

Returns UintRangeArray<T>

hasNumberFields

Returns boolean

invert

Parameters

Returns UintRangeArray<T>

isFull

Returns boolean

overlaps

Parameters

Returns boolean

search

Parameters

Returns boolean

size

Returns T

toArray

Returns UintRangeArray<T>

toJson

Returns JsonObject

toJsonString

Returns string

toProto

Returns proto.badges.UintRange

StaticFrom

Type Parameters

Parameters

Returns UintRange<T>

StaticFullRange

Returns UintRange<bigint>

StaticFullRanges

Returns UintRangeArray<bigint>

Protected StaticcreateUintRange

Type Parameters

Parameters

Returns UintRange<T>

StaticfromJson

Type Parameters

Parameters

Parameters

Returns U

Returns UintRange<U>

StaticfromJsonString

Type Parameters

`Static`From

`Static`FullRange

`Static`FullRanges

`Protected` `Static`createUintRange

`Static`fromJson

`Static`fromJsonString

`Static`fromProto