Class ChainAlias
Hierarchy-Diagram
Legend
class
public method
Hierarchy (view full)
- UInt8
- ChainAlias
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new
Chain Alias(value): ChainAlias Create a new instance, don't use this directly. Use the
.fromfactory method instead.Parameters
- value: BN
Returns ChainAlias
Throws
If the value over- or under-flows the integer type.
Properties
value
The underlying BN.js instance – don't modify this
directly – take a copy first using .clone().
Static abi
Static byte
Static is
Accessors
byte
- get byteArray(): Uint8Array
Number as bytes in little endian (matches memory layout in C++ contract).
Returns Uint8Array
Static max
- get max(): BN
Largest value that can be represented by this integer type.
Returns BN
Static min
- get min(): BN
Smallest value that can be represented by this integer type.
Returns BN
Methods
[to
add
adding
- adding(num): ChainAlias
Non-mutating add.
Parameters
- num: IntType
Returns ChainAlias
cast
divide
- divide(by, behavior?): void
Mutating divide.
Parameters
- by: IntType
Optionalbehavior: DivisionBehaviorHow to handle the remainder, default is to floor (round down).
Returns void
Throws
When dividing by zero.
dividing
- dividing(by, behavior?): ChainAlias
Non-mutating divide.
Parameters
- by: IntType
Optionalbehavior: DivisionBehaviorHow to handle the remainder, default is to floor (round down).
Returns ChainAlias
Throws
When dividing by zero.
equals
gt
- gt(other): boolean
Greater than comparision operator
Parameters
- other: Int
Returns boolean
gte
- gte(other): boolean
Greater than or equal comparision operator
Parameters
- other: Int
Returns boolean
lt
- lt(other): boolean
Less than comparision operator
Parameters
- other: Int
Returns boolean
lte
- lte(other): boolean
Less than or equal comparision operator
Parameters
- other: Int
Returns boolean
multiply
multiplying
- multiplying(by): ChainAlias
Non-mutating multiply.
Parameters
- by: IntType
Returns ChainAlias
subtract
subtracting
- subtracting(num): ChainAlias
Non-mutating subtract.
Parameters
- num: IntType
Returns ChainAlias
toABI
- toABI(encoder): void
Called when encoding to binary abi format.
Parameters
- encoder: ABIEncoder
Returns void
toJSON
to
to
Static abi
Static add
- add(lhs, rhs, overflow?): Int
Add
lhstorhsand return the resulting value.Parameters
- lhs: Int
- rhs: Int
- overflow: OverflowBehavior = 'truncate'
Returns Int
Static div
- div(lhs, rhs, overflow?): Int
Divide
lhsbyrhsand return the quotient, dropping the remainder.Parameters
- lhs: Int
- rhs: Int
Optionaloverflow: OverflowBehavior
Returns Int
Throws
When dividing by zero.
Static div
- div
Ceil(lhs, rhs, overflow?): Int Divide
lhsbyrhsand return the quotient + remainder rounded up to the closest integer.Parameters
- lhs: Int
- rhs: Int
Optionaloverflow: OverflowBehavior
Returns Int
Throws
When dividing by zero.
Static div
- div
Round(lhs, rhs, overflow?): Int Divide
lhsbyrhsand return the quotient + remainder rounded to the closest integer.Parameters
- lhs: Int
- rhs: Int
Optionaloverflow: OverflowBehavior
Returns Int
Throws
When dividing by zero.
Static from
- from<T>(this, value, overflow?): InstanceType<T>
Create a new instance from value.
Type Parameters
- T extends typeof Int
Parameters
- this: T
- value: Uint8Array | IntType
Value to create new Int instance from, can be a string, number, little-endian byte array or another Int instance.
Optionaloverflow: OverflowBehaviorHow to handle integer overflow, default behavior is to throw.
Returns InstanceType<T>
- from(value, overflow?): unknown
Parameters
- value: any
Optionaloverflow: OverflowBehavior
Returns unknown
Static fromABI
- fromABI<T>(this, decoder): InstanceType<T>
Type Parameters
- T extends typeof Int
Parameters
- this: T
- decoder: ABIDecoder
Returns InstanceType<T>
- fromABI(decoder): unknown
Parameters
- decoder: ABIDecoder
Returns unknown
Static gt
Static gte
Static lt
Static lte
Static mul
- mul(lhs, rhs, overflow?): Int
Multiply
lhsbyrhsand return the resulting value.Parameters
- lhs: Int
- rhs: Int
Optionaloverflow: OverflowBehavior
Returns Int
Static random
Static sub
- sub(lhs, rhs, overflow?): Int
Add
lhstorhsand return the resulting value.Parameters
- lhs: Int
- rhs: Int
Optionaloverflow: OverflowBehavior
Returns Int
Binary integer with the underlying value represented by a BN.js instance. Follows C++11 standard for arithmetic operators and conversions.
Note
This type is optimized for correctness not speed, if you plan to manipulate integers in a tight loop you're advised to use the underlying BN.js value or convert to a JavaScript number first.