name: ProposalIndex

description: An increasing number that represents a specific council proposal index in the system, implemented as U32

Hierarchy

↳ U32

↳ ProposalIndex

Implements

Constructors

constructor

⊕ new ProposalIndex(value?: AnyNumber): ProposalIndex

Inherited from U32.constructor

Overrides UInt.constructor

Defined in primitive/U32.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: ProposalIndex


Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean


Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN


add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN


addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN


and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN


andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN


bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN


bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength


byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number


clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN


cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1


cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1


div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN


divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN


divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN


egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object


eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean


eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean


fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN


gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN


gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean


gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean


gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean


gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean


iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN


iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN


iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN


iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN


idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN


imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN


imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN


imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN


ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN


inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN


invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN


ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN


isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean


isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean


isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean


isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean


ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN


ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN


isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN


isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN


isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN


iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN


iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN


iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN


iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN


iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN


ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN


lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean


lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean


lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean


ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean


maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN


mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN


modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number


mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN


muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN


neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN


notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN


or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN


pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN


setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN


shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN


shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN


sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN


sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN


subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN


testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean


toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]


toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]


toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer


toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number


toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN


toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string


toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array


uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN


ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1


umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN


uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN


ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN


ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN


uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN


xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN


zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number


<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string


<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean


<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN


<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN


<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext


<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext


Last Updated: 2/25/2019, 4:39:16 PM