Class BalanceArray<T>

Type Parameters

T extends NumberType

Hierarchy

BaseTypedArray<BalanceArray<T>, Balance<T>>
- BalanceArray

Implements

BalanceFunctions<T>

Index

Constructors

constructor

Methods

addBalance addBalances applyIncrements clone convert equalBalances every filterZeroBalances getAllBadgeIds getBalanceForIdAndTime getBalancesForId getBalancesForTime sortBalancesByAmount subsetOf subtractBalance subtractBalances updateBalances From

Constructors

constructor

new BalanceArray<T>(arrayLength): BalanceArray<T>
Type Parameters
- T extends NumberType
Parameters
- arrayLength: number
Returns BalanceArray<T>
Inherited from BaseTypedArray<BalanceArray<T>, Balance<T>>.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1508
new BalanceArray<T>(...items): BalanceArray<T>
Type Parameters
- T extends NumberType
Parameters
- Rest...items: Balance<T>[]
Returns BalanceArray<T>
Inherited from BaseTypedArray<BalanceArray<T>, Balance<T>>.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1509

Methods

addBalance

addBalance(balanceToAdd): this
Adds the balanceToAdd to the existing balances. Returns a new BalanceArray.
Parameters
- balanceToAdd: iBalance<T>
Returns this
Remarks
Can also be used via the corresponding method with same name on BalanceArray
Implementation of BalanceFunctions.addBalance
- Defined in src/core/balances.ts:873

addBalances

addBalances(balancesToAdd): this
Adds multiple balances to the existing balances. Returns a new BalanceArray.
Parameters
- balancesToAdd: BalanceArray<T> | iBalance<T>[]
Returns this
Remarks
Can also be used via the corresponding method with same name on BalanceArray
Implementation of BalanceFunctions.addBalances
- Defined in src/core/balances.ts:863

applyIncrements

applyIncrements(incrementBadgeIdsBy, incrementOwnershipTimesBy, numIncrements): BalanceArray<T>
{@inheritDoc applyIncrementsToBalances}
Parameters
- incrementBadgeIdsBy: T
- incrementOwnershipTimesBy: T
- numIncrements: T
Returns BalanceArray<T>
Implementation of BalanceFunctions.applyIncrements
- Defined in src/core/balances.ts:910

clone

clone(): BalanceArray<T>
Returns BalanceArray<T>
- Defined in src/core/balances.ts:793

convert

convert<U>(convertFunction, options?): BalanceArray<U>
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item: NumberType) => U)
  - - (item): U
    - Parameters
      item: NumberType
      Returns U
- Optionaloptions: ConvertOptions
Returns BalanceArray<U>
- Defined in src/core/balances.ts:789

equalBalances

equalBalances(other, checkZeroBalances?): boolean
Checks if two balances are equal. Flag to check if the balances with zero amounts should be checked as well.
Parameters
- other: BalanceArray<T> | iBalance<T>[]
- checkZeroBalances: boolean = false
Returns boolean
Remarks
Can also be used via the corresponding method with same name on BalanceArray
Implementation of BalanceFunctions.equalBalances
- Defined in src/core/balances.ts:842

every

every(predicate, thisArg?): boolean
Determines whether all the members of an array satisfy the specified test.
Parameters
- predicate: ((value: Balance<T>, index: number, array: BalanceArray<T>) => unknown)
  A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
  - - (value, index, array): unknown
    - Parameters
      value: Balance<T>
      index: number
      array: BalanceArray<T>
      Returns unknown
- OptionalthisArg: any
  An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns boolean
Inherited from BaseTypedArray.every
- Defined in src/common/typed-arrays.ts:100

filterZeroBalances

filterZeroBalances(): this
Filters out all balances with amount == 0. Returns a new BalanceArray.

Returns this
Remarks
Can also be used via the corresponding method with same name on BalanceArray
Implementation of BalanceFunctions.filterZeroBalances
- Defined in src/core/balances.ts:821

getAllBadgeIds

getAllBadgeIds(): UintRangeArray<T>
Gets all badge IDs from the balances (sorted and merged).

Returns UintRangeArray<T>
- Defined in src/core/balances.ts:920

getBalanceForIdAndTime

getBalanceForIdAndTime(badgeId, ownedTime): T
{@inheritDoc getBalanceForIdAndTime}
Parameters
- badgeId: T
- ownedTime: T
Returns T
Implementation of BalanceFunctions.getBalanceForIdAndTime
- Defined in src/core/balances.ts:800

getBalancesForId

getBalancesForId(badgeId): BalanceArray<T>
Returns all matching balances for a specific badge ID. Returns a new BalanceArray.
Parameters
- badgeId: T
Returns BalanceArray<T>
Remarks
Can also be used via the corresponding method with same name on BalanceArray
Implementation of BalanceFunctions.getBalancesForId
- Defined in src/core/balances.ts:807

getBalancesForTime

getBalancesForTime(ownedTime): BalanceArray<T>
Returns all matching balances for a specific time via a new BalanceArray.
Parameters
- ownedTime: T
Returns BalanceArray<T>
Remarks
Can also be used via the corresponding method with same name on BalanceArray
Implementation of BalanceFunctions.getBalancesForTime
- Defined in src/core/balances.ts:814

sortBalancesByAmount

sortBalancesByAmount(): BalanceArray<T>
Sorts balances by their amount property. Returns a new BalanceArray.

Returns BalanceArray<T>
Remarks
Can also be used via the corresponding method with same name on BalanceArray
Implementation of BalanceFunctions.sortBalancesByAmount
- Defined in src/core/balances.ts:900

subsetOf

subsetOf(threshold): boolean
Checks if the current balances are a subset of the threshold balances (i.e. doesn't exceed the threshold).
Parameters
- threshold: BalanceArray<T> | iBalance<T>[]
Returns boolean
Implementation of BalanceFunctions.subsetOf
- Defined in src/core/balances.ts:831

subtractBalance

subtractBalance(balanceToSubtract, allowUnderflow): BalanceArray<T>
Subtracts the balanceToRemove from the existing balances. Returns a new BalanceArray.

Throws an error if the balances underflow.
Parameters
- balanceToSubtract: iBalance<T>
- allowUnderflow: boolean
Returns BalanceArray<T>
Remarks
Can also be used via the corresponding method with same name on BalanceArray
Implementation of BalanceFunctions.subtractBalance
- Defined in src/core/balances.ts:893

subtractBalances

subtractBalances(balancesToSubtract, allowNegatives?): BalanceArray<T>
Subtracts multiple balances from the existing balances. Returns a new BalanceArray.

Throws an error if the balances underflow.
Parameters
- balancesToSubtract: BalanceArray<T> | iBalance<T>[]
- allowNegatives: boolean = false
Returns BalanceArray<T>
Remarks
Can also be used via the corresponding method with same name on BalanceArray
Implementation of BalanceFunctions.subtractBalances
- Defined in src/core/balances.ts:883

updateBalances

updateBalances(newBalance): this
Updates the balance for what it currently is to newAmount.
Parameters
- newBalance: iBalance<T>
Returns this
Remarks
Returns a new BalanceArray. Does not modify the original.

Can also be used via the corresponding method with same name on BalanceArray
Implementation of BalanceFunctions.updateBalances
- Defined in src/core/balances.ts:853

`Static`From

From<T>(arr): BalanceArray<T>
Type Parameters
- T extends NumberType
Parameters
- arr: iBalance<T> | iBalance<T>[] | BalanceArray<T>
Returns BalanceArray<T>
- Defined in src/core/balances.ts:756

Class BalanceArray<T>

Type Parameters

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BalanceArray<T>

Type Parameters

Parameters

Returns BalanceArray<T>

Methods

addBalance

Parameters

Returns this

Remarks

addBalances

Parameters

Returns this

Remarks

applyIncrements

Parameters

Returns BalanceArray<T>

clone

Returns BalanceArray<T>

convert

Type Parameters

Parameters

Parameters

Returns U

Returns BalanceArray<U>

equalBalances

Parameters

Returns boolean

Remarks

every

Parameters

Parameters

Returns unknown

Returns boolean

filterZeroBalances

Returns this

Remarks

getAllBadgeIds

Returns UintRangeArray<T>

getBalanceForIdAndTime

Parameters

Returns T

getBalancesForId

Parameters

Returns BalanceArray<T>

Remarks

getBalancesForTime

Parameters

Returns BalanceArray<T>

Remarks

sortBalancesByAmount

Returns BalanceArray<T>

Remarks

subsetOf

Parameters

Returns boolean

subtractBalance

Parameters

Returns BalanceArray<T>

Remarks

subtractBalances

Parameters

Returns BalanceArray<T>

Remarks

updateBalances

Parameters

Returns this

Remarks

StaticFrom

Type Parameters

`Static`From