Class RequestFlags

Hierarchy

UInt8
- RequestFlags

Index

Constructors

constructor

new RequestFlags(value: BN): RequestFlags
Create a new instance, don't use this directly. Use the .from factory method instead.
Parameters
- value: BN
Returns RequestFlags

Throws
If the value over- or under-flows the integer type.
Inherited from UInt8.constructor
- Defined in antelope/lib/antelope.d.ts:535

Properties

value

value: BN

The underlying BN.js instance – don't modify this directly – take a copy first using .clone().

`Static`abiName

abiName: string

`Static`background

background: number = ...

`Static`broadcast

broadcast: number = ...

`Static`byteWidth

byteWidth: number

`Static`isSigned

isSigned: boolean

Accessors

background

get background(): boolean
Returns boolean
- Defined in signing-request/src/abi.ts:57
set background(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in signing-request/src/abi.ts:60

broadcast

get broadcast(): boolean
Returns boolean
- Defined in signing-request/src/abi.ts:50
set broadcast(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in signing-request/src/abi.ts:53

byteArray

get byteArray(): Uint8Array
Number as bytes in little endian (matches memory layout in C++ contract).

Returns Uint8Array
Inherited from UInt8.byteArray
- Defined in antelope/lib/antelope.d.ts:542

`Static`max

get max(): BN
Largest value that can be represented by this integer type.

Returns BN
Inherited from UInt8.max
- Defined in antelope/lib/antelope.d.ts:474

`Static`min

get min(): BN
Smallest value that can be represented by this integer type.

Returns BN
Inherited from UInt8.min
- Defined in antelope/lib/antelope.d.ts:476

`Static`zero

get zero(): Int
Return a zero value of this type

Returns Int
Inherited from UInt8.zero
- Defined in antelope/lib/antelope.d.ts:478

Methods

[toPrimitive]

"[toPrimitive]"(type: string): string | number
Parameters
- type: string
Returns string | number
Inherited from UInt8.[toPrimitive]
- Defined in antelope/lib/antelope.d.ts:591

add

add(num: IntType): void
Mutating add.
Parameters
- num: IntType
Returns void
Inherited from UInt8.add
- Defined in antelope/lib/antelope.d.ts:549

adding

adding(num: IntType): this
Non-mutating add.
Parameters
- num: IntType
Returns this
Inherited from UInt8.adding
- Defined in antelope/lib/antelope.d.ts:551

cast

cast<T extends typeof Int>(
type: T,
overflow?: OverflowBehavior,
): InstanceType<T>
Cast this integer to other type.
Type Parameters
- T extends typeof Int
Parameters
- type: T
- Optionaloverflow: OverflowBehavior
  How to handle overflow, default is to preserve bit-pattern (C++11 behavior).
Returns InstanceType<T>
Inherited from UInt8.cast
- Defined in antelope/lib/antelope.d.ts:540

divide

divide(by: IntType, behavior?: DivisionBehavior): void
Mutating divide.
Parameters
- by: IntType
- Optionalbehavior: DivisionBehavior
  How to handle the remainder, default is to floor (round down).
Returns void

Throws
When dividing by zero.
Inherited from UInt8.divide
- Defined in antelope/lib/antelope.d.ts:565

dividing

dividing(by: IntType, behavior?: DivisionBehavior): this
Non-mutating divide.
Parameters
- by: IntType
- Optionalbehavior: DivisionBehavior
  How to handle the remainder, default is to floor (round down).
Returns this

Throws
When dividing by zero.
Inherited from UInt8.dividing
- Defined in antelope/lib/antelope.d.ts:571

equals

equals(other: Uint8Array<ArrayBufferLike> | IntType, strict?: boolean): boolean
Compare two integers, if strict is set to true the test will only consider integers of the exact same type. I.e. Int64.from(1).equals(UInt64.from(1)) will return false.
Parameters
- other: Uint8Array<ArrayBufferLike> | IntType
- Optionalstrict: boolean
Returns boolean
Inherited from UInt8.equals
- Defined in antelope/lib/antelope.d.ts:547

gt

gt(other: Int): boolean
Greater than comparision operator
Parameters
- other: Int
Returns boolean
Inherited from UInt8.gt
- Defined in antelope/lib/antelope.d.ts:573

gte

gte(other: Int): boolean
Greater than or equal comparision operator
Parameters
- other: Int
Returns boolean
Inherited from UInt8.gte
- Defined in antelope/lib/antelope.d.ts:577

lt

lt(other: Int): boolean
Less than comparision operator
Parameters
- other: Int
Returns boolean
Inherited from UInt8.lt
- Defined in antelope/lib/antelope.d.ts:575

lte

lte(other: Int): boolean
Less than or equal comparision operator
Parameters
- other: Int
Returns boolean
Inherited from UInt8.lte
- Defined in antelope/lib/antelope.d.ts:579

multiply

multiply(by: IntType): void
Mutating multiply.
Parameters
- by: IntType
Returns void
Inherited from UInt8.multiply
- Defined in antelope/lib/antelope.d.ts:557

multiplying

multiplying(by: IntType): this
Non-mutating multiply.
Parameters
- by: IntType
Returns this
Inherited from UInt8.multiplying
- Defined in antelope/lib/antelope.d.ts:559

subtract

subtract(num: IntType): void
Mutating subtract.
Parameters
- num: IntType
Returns void
Inherited from UInt8.subtract
- Defined in antelope/lib/antelope.d.ts:553

subtracting

subtracting(num: IntType): this
Non-mutating subtract.
Parameters
- num: IntType
Returns this
Inherited from UInt8.subtracting
- Defined in antelope/lib/antelope.d.ts:555

toABI

toABI(encoder: ABIEncoder): void
Called when encoding to binary abi format.
Parameters
- encoder: ABIEncoder
Returns void
Inherited from UInt8.toABI
- Defined in antelope/lib/antelope.d.ts:592

toJSON

toJSON(): string | number
Called when encoding to json abi format.

Returns string | number
Inherited from UInt8.toJSON
- Defined in antelope/lib/antelope.d.ts:593

toNumber

toNumber(): number
Convert to a JavaScript number.

Returns number

Throws
If the number cannot be represented by 53-bits.
Inherited from UInt8.toNumber
- Defined in antelope/lib/antelope.d.ts:589

toString

toString(): string
Returns a string representation of an object.

Returns string
Inherited from UInt8.toString
- Defined in antelope/lib/antelope.d.ts:590

`Static`abiDefault

abiDefault(): Int
Returns Int
Inherited from UInt8.abiDefault
- Defined in antelope/lib/antelope.d.ts:523

`Static`add

add(lhs: Int, rhs: Int, overflow?: OverflowBehavior): Int
Add lhs to rhs and return the resulting value.
Parameters
- lhs: Int
- rhs: Int
- Optionaloverflow: OverflowBehavior
Returns Int
Inherited from UInt8.add
- Defined in antelope/lib/antelope.d.ts:480

`Static`div

div(lhs: Int, rhs: Int, overflow?: OverflowBehavior): Int
Divide lhs by rhs and return the quotient, dropping the remainder.
Parameters
- lhs: Int
- rhs: Int
- Optionaloverflow: OverflowBehavior
Returns Int

Throws
When dividing by zero.
Inherited from UInt8.div
- Defined in antelope/lib/antelope.d.ts:489

`Static`divCeil

divCeil(lhs: Int, rhs: Int, overflow?: OverflowBehavior): Int
Divide lhs by rhs and return the quotient + remainder rounded up to the closest integer.
Parameters
- lhs: Int
- rhs: Int
- Optionaloverflow: OverflowBehavior
Returns Int

Throws
When dividing by zero.
Inherited from UInt8.divCeil
- Defined in antelope/lib/antelope.d.ts:499

`Static`divRound

divRound(lhs: Int, rhs: Int, overflow?: OverflowBehavior): Int
Divide lhs by rhs and return the quotient + remainder rounded to the closest integer.
Parameters
- lhs: Int
- rhs: Int
- Optionaloverflow: OverflowBehavior
Returns Int

Throws
When dividing by zero.
Inherited from UInt8.divRound
- Defined in antelope/lib/antelope.d.ts:494

`Static`from

from<T extends typeof Int>(
    this: T,
    value: Uint8Array<ArrayBufferLike> | IntType,
    overflow?: OverflowBehavior,
): InstanceType<T>
Create a new instance from value.
Type Parameters
- T extends typeof Int
Parameters
- this: T
- value: Uint8Array<ArrayBufferLike> | IntType
  Value to create new Int instance from, can be a string, number, little-endian byte array or another Int instance.
- Optionaloverflow: OverflowBehavior
  How to handle integer overflow, default behavior is to throw.
Returns InstanceType<T>
Inherited from UInt8.from
- Defined in antelope/lib/antelope.d.ts:519
from(value: any, overflow?: OverflowBehavior): unknown
Create a new instance from value.
Parameters
- value: any
  Value to create new Int instance from, can be a string, number, little-endian byte array or another Int instance.
- Optionaloverflow: OverflowBehavior
  How to handle integer overflow, default behavior is to throw.
Returns unknown
Inherited from UInt8.from
- Defined in antelope/lib/antelope.d.ts:520

`Static`fromABI

fromABI<T extends typeof Int>(this: T, decoder: ABIDecoder): InstanceType<T>
Type Parameters
- T extends typeof Int
Parameters
- this: T
- decoder: ABIDecoder
Returns InstanceType<T>
Inherited from UInt8.fromABI
- Defined in antelope/lib/antelope.d.ts:521
fromABI(decoder: ABIDecoder): unknown
Parameters
- decoder: ABIDecoder
Returns unknown
Inherited from UInt8.fromABI
- Defined in antelope/lib/antelope.d.ts:522

`Static`gt

gt(lhs: Int, rhs: Int): boolean
Compare lhs to rhs and return true if lhs is greater than rhs.
Parameters
- lhs: Int
- rhs: Int
Returns boolean
Inherited from UInt8.gt
- Defined in antelope/lib/antelope.d.ts:501

`Static`gte

gte(lhs: Int, rhs: Int): boolean
Compare lhs to rhs and return true if lhs is greater than or equal to rhs.
Parameters
- lhs: Int
- rhs: Int
Returns boolean
Inherited from UInt8.gte
- Defined in antelope/lib/antelope.d.ts:505

`Static`lt

lt(lhs: Int, rhs: Int): boolean
Compare lhs to rhs and return true if lhs is less than rhs.
Parameters
- lhs: Int
- rhs: Int
Returns boolean
Inherited from UInt8.lt
- Defined in antelope/lib/antelope.d.ts:503

`Static`lte

lte(lhs: Int, rhs: Int): boolean
Compare lhs to rhs and return true if lhs is less than or equal to rhs.
Parameters
- lhs: Int
- rhs: Int
Returns boolean
Inherited from UInt8.lte
- Defined in antelope/lib/antelope.d.ts:507

`Static`mul

mul(lhs: Int, rhs: Int, overflow?: OverflowBehavior): Int
Multiply lhs by rhs and return the resulting value.
Parameters
- lhs: Int
- rhs: Int
- Optionaloverflow: OverflowBehavior
Returns Int
Inherited from UInt8.mul
- Defined in antelope/lib/antelope.d.ts:484

`Static`random

random<T extends typeof Int>(this: T): InstanceType<T>
Type Parameters
- T extends typeof Int
Parameters
- this: T
Returns InstanceType<T>
Inherited from UInt8.random
- Defined in antelope/lib/antelope.d.ts:524
random(): unknown
Returns unknown
Inherited from UInt8.random
- Defined in antelope/lib/antelope.d.ts:525

`Static`sub

sub(lhs: Int, rhs: Int, overflow?: OverflowBehavior): Int
Add lhs to rhs and return the resulting value.
Parameters
- lhs: Int
- rhs: Int
- Optionaloverflow: OverflowBehavior
Returns Int
Inherited from UInt8.sub
- Defined in antelope/lib/antelope.d.ts:482

Class RequestFlags

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RequestFlags

Throws

Properties

value

StaticabiName

Staticbackground

Staticbroadcast

StaticbyteWidth

StaticisSigned

Accessors

background

Returns boolean

Parameters

Returns void

broadcast

Returns boolean

Parameters

Returns void

byteArray

Returns Uint8Array

Staticmax

Returns BN

Staticmin

Returns BN

Staticzero

Returns Int

Methods

[toPrimitive]

Parameters

Returns string | number

add

Parameters

Returns void

adding

Parameters

Returns this

cast

Type Parameters

Parameters

Returns InstanceType<T>

divide

Parameters

Returns void

Throws

dividing

Parameters

Returns this

Throws

equals

Parameters

Returns boolean

gt

Parameters

Returns boolean

gte

Parameters

Returns boolean

lt

Parameters

Returns boolean

lte

Parameters

Returns boolean

multiply

Parameters

Returns void

multiplying

Parameters

Returns this

subtract

`Static`abiName

`Static`background

`Static`broadcast

`Static`byteWidth

`Static`isSigned

`Static`max

`Static`min

`Static`zero

`Static`abiDefault

`Static`add

`Static`div

`Static`divCeil

`Static`divRound

`Static`from

`Static`fromABI

`Static`gt

`Static`gte

`Static`lt

`Static`lte

`Static`mul

`Static`random

`Static`sub