From 73710b708bc5892cddb0cfd939f1aa9b42839029 Mon Sep 17 00:00:00 2001 From: Amaury Martiny Date: Tue, 13 Nov 2018 12:49:21 +0100 Subject: [PATCH 1/2] U8a extends Uint8Array (#392) * U8a implements Codec * Fix U8aFixed * Fix Bytes * Fix AccountId * Remove if instanceof U8a * Fix Bytes * Fix lint * Fix AccountId * Remove any type * Remove isBuffer * Use this directly --- packages/types/src/AccountId.ts | 19 +++++----- packages/types/src/AccountIndex.ts | 3 -- packages/types/src/Address.ts | 3 -- packages/types/src/Bool.ts | 5 +-- packages/types/src/Bytes.ts | 20 +++++------ packages/types/src/Event.ts | 8 ++--- packages/types/src/Extrinsic.ts | 3 -- packages/types/src/ExtrinsicEra.ts | 4 +-- packages/types/src/ExtrinsicSignature.ts | 5 +-- packages/types/src/Method.ts | 7 ++-- packages/types/src/Moment.ts | 3 -- packages/types/src/StorageKey.ts | 3 -- packages/types/src/Text.ts | 3 -- packages/types/src/codec/Compact.ts | 5 +-- packages/types/src/codec/Enum.ts | 7 ++-- packages/types/src/codec/EnumType.ts | 5 +-- packages/types/src/codec/Set.ts | 9 ++--- packages/types/src/codec/Struct.ts | 11 +++--- .../src/codec/{U8a.spec.js => U8a.spec.ts} | 21 +++++++---- packages/types/src/codec/U8a.ts | 36 ++++++++++--------- .../{U8aFixed.spec.js => U8aFixed.spec.ts} | 8 +++-- packages/types/src/codec/U8aFixed.ts | 30 ++++++++-------- packages/types/src/codec/UInt.ts | 3 -- packages/types/src/codec/Vector.ts | 9 ++--- packages/types/src/types.d.ts | 8 +++-- 25 files changed, 99 insertions(+), 139 deletions(-) rename packages/types/src/codec/{U8a.spec.js => U8a.spec.ts} (69%) rename packages/types/src/codec/{U8aFixed.spec.js => U8aFixed.spec.ts} (80%) diff --git a/packages/types/src/AccountId.ts b/packages/types/src/AccountId.ts index fa3ba51947..fb642e79a0 100644 --- a/packages/types/src/AccountId.ts +++ b/packages/types/src/AccountId.ts @@ -2,12 +2,11 @@ // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. -import { AnyU8a } from './types'; +import { AnyString, AnyU8a } from './types'; import { decodeAddress, encodeAddress } from '@polkadot/keyring'; -import { hexToU8a, isHex, isU8a, u8aToU8a } from '@polkadot/util'; +import { hexToU8a, isHex, isString, isU8a, u8aToU8a } from '@polkadot/util'; -import U8a from './codec/U8a'; import U8aFixed from './codec/U8aFixed'; // A wrapper around an AccountId/PublicKey representation. Since we are dealing with @@ -25,16 +24,16 @@ export default class AccountId extends U8aFixed { return encodeAddress(value); } - static decodeAccountId (value: AnyU8a): Uint8Array { - if (value instanceof U8a) { - return value.raw; - } else if (isU8a(value) || Array.isArray(value)) { + private static decodeAccountId (value: AnyU8a | AnyString): Uint8Array { + if (isU8a(value) || Array.isArray(value)) { return u8aToU8a(value); } else if (isHex(value)) { - return hexToU8a(value); + return hexToU8a(value.toString()); + } else if (isString(value)) { + return decodeAddress((value as AnyString).toString()); } - return decodeAddress(value); + return value; } toJSON (): any { @@ -42,6 +41,6 @@ export default class AccountId extends U8aFixed { } toString (): string { - return AccountId.encode(this.raw); + return AccountId.encode(this); } } diff --git a/packages/types/src/AccountIndex.ts b/packages/types/src/AccountIndex.ts index 9ed0e01750..3b9ad6b836 100644 --- a/packages/types/src/AccountIndex.ts +++ b/packages/types/src/AccountIndex.ts @@ -7,7 +7,6 @@ import { decodeAddress, encodeAddress } from '@polkadot/keyring'; import { bnToBn, bnToU8a, isBn, isNumber, isU8a, isHex, hexToU8a, u8aToHex } from '@polkadot/util'; import { AnyNumber } from './types'; -import U8a from './codec/U8a'; import UInt from './codec/UInt'; import U32 from './U32'; @@ -34,8 +33,6 @@ export default class AccountIndex extends U32 { static decodeAccountIndex (value: AnyNumber): BN | Uint8Array | number | string { if (value instanceof UInt) { return value.raw; - } else if (value instanceof U8a) { - return AccountIndex.decodeAccountIndex(value.raw); } else if (isBn(value) || isNumber(value) || isU8a(value)) { return value; } else if (isHex(value)) { diff --git a/packages/types/src/Address.ts b/packages/types/src/Address.ts index fb566c82e3..c5e2b8aab9 100644 --- a/packages/types/src/Address.ts +++ b/packages/types/src/Address.ts @@ -7,7 +7,6 @@ import { decodeAddress } from '@polkadot/keyring'; import { hexToU8a, isBn, isHex, isNumber, isU8a, u8aConcat, u8aToHex, u8aToU8a, u8aToBn } from '@polkadot/util'; import Base from './codec/Base'; -import U8a from './codec/U8a'; import AccountId from './AccountId'; import AccountIndex from './AccountIndex'; @@ -34,8 +33,6 @@ export default class Address extends Base { return value.raw; } else if (value instanceof AccountId || value instanceof AccountIndex) { return value; - } else if (value instanceof U8a) { - return Address.decodeAddress(value.raw); } else if (Array.isArray(value)) { return Address.decodeAddress(u8aToU8a(value)); } else if (isU8a(value)) { diff --git a/packages/types/src/Bool.ts b/packages/types/src/Bool.ts index 4b4f243c43..0ffafddf9a 100644 --- a/packages/types/src/Bool.ts +++ b/packages/types/src/Bool.ts @@ -5,10 +5,9 @@ import { isU8a } from '@polkadot/util'; import Base from './codec/Base'; -import U8a from './codec/U8a'; export default class Bool extends Base { - constructor (value: Bool | U8a | Boolean | Uint8Array | boolean = false) { + constructor (value: Bool | Boolean | Uint8Array | boolean = false) { super( Bool.decodeBool(value) ); @@ -17,8 +16,6 @@ export default class Bool extends Base { static decodeBool (value: any): boolean { if (value instanceof Bool || value instanceof Boolean) { return value.valueOf(); - } else if (value instanceof U8a) { - return Bool.decodeBool(value.raw); } else if (isU8a(value)) { return value[0] === 1; } diff --git a/packages/types/src/Bytes.ts b/packages/types/src/Bytes.ts index 79b3b242c7..951ad5dbe7 100644 --- a/packages/types/src/Bytes.ts +++ b/packages/types/src/Bytes.ts @@ -2,7 +2,7 @@ // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. -import { hexToU8a, isHex, isU8a, u8aConcat, u8aToU8a } from '@polkadot/util'; +import { hexToU8a, isHex, isString, isU8a, u8aConcat, u8aToU8a } from '@polkadot/util'; import { AnyU8a } from './types'; import Compact, { DEFAULT_LENGTH_BITS } from './codec/Compact'; @@ -16,10 +16,8 @@ export default class Bytes extends U8a { super(Bytes.decodeBytes(value)); } - static decodeBytes (value: AnyU8a): Uint8Array { - if (value instanceof U8a) { - return value.raw; - } else if (isHex(value)) { + private static decodeBytes (value: AnyU8a): Uint8Array { + if (isHex(value)) { // FIXME We manually add the length prefix for hex for now // https://github.com/paritytech/substrate/issues/889 const u8a = hexToU8a(value); @@ -31,13 +29,11 @@ export default class Bytes extends U8a { const [offset, length] = Compact.decodeU8a(value, DEFAULT_LENGTH_BITS); return value.subarray(offset, offset + length.toNumber()); + } else if (Array.isArray(value) || isString(value)) { + return Bytes.decodeBytes(u8aToU8a(value)); } - return Bytes.decodeBytes(u8aToU8a(value)); - } - - get length (): number { - return this.raw.length; + return value; } get encodedLength (): number { @@ -46,10 +42,10 @@ export default class Bytes extends U8a { toU8a (isBare?: boolean): Uint8Array { return isBare - ? this.raw + ? this : u8aConcat( Compact.encodeU8a(this.length, DEFAULT_LENGTH_BITS), - this.raw + this ); } } diff --git a/packages/types/src/Event.ts b/packages/types/src/Event.ts index dc08367f14..82f5c65773 100644 --- a/packages/types/src/Event.ts +++ b/packages/types/src/Event.ts @@ -8,7 +8,6 @@ import { isUndefined, stringCamelCase, u8aToHex } from '@polkadot/util'; import Struct from './codec/Struct'; import Tuple from './codec/Tuple'; -import U8a from './codec/U8a'; import U8aFixed from './codec/U8aFixed'; import { TypeDef, getTypeClass, getTypeDef } from './codec/createType'; import Metadata, { EventMetadata } from './Metadata'; @@ -57,7 +56,7 @@ class EventIndex extends U8aFixed { export default class Event extends Struct { // Currently we _only_ decode from Uint8Array, since we expect it to // be used via EventRecord - constructor (_value: Uint8Array | U8a) { + constructor (_value: Uint8Array) { const { DataType, value } = Event.decodeEvent(_value); super({ @@ -66,10 +65,7 @@ export default class Event extends Struct { }, value); } - static decodeEvent (_value: U8a | Uint8Array) { - const value = _value instanceof U8a - ? _value.raw - : _value; + static decodeEvent (value: Uint8Array) { const index = value.subarray(0, 2); const DataType = EventTypes[index.toString()]; diff --git a/packages/types/src/Extrinsic.ts b/packages/types/src/Extrinsic.ts index 54ea21ea38..0f86dd6077 100644 --- a/packages/types/src/Extrinsic.ts +++ b/packages/types/src/Extrinsic.ts @@ -11,7 +11,6 @@ import { blake2AsU8a } from '@polkadot/util-crypto'; import Base from './codec/Base'; import Compact, { DEFAULT_LENGTH_BITS } from './codec/Compact'; import Struct from './codec/Struct'; -import U8a from './codec/U8a'; import ExtrinsicSignature from './ExtrinsicSignature'; import Hash from './Hash'; import { FunctionMetadata } from './Metadata'; @@ -45,8 +44,6 @@ export default class Extrinsic extends Struct { return {}; } else if (value instanceof Extrinsic) { return value.raw; - } else if (value instanceof U8a) { - return Extrinsic.decodeExtrinsic(value.raw); } else if (isHex(value)) { // FIXME We manually add the length prefix for hex for now // https://github.com/paritytech/substrate/issues/889 diff --git a/packages/types/src/ExtrinsicEra.ts b/packages/types/src/ExtrinsicEra.ts index 830c0fd28d..416cbda11b 100644 --- a/packages/types/src/ExtrinsicEra.ts +++ b/packages/types/src/ExtrinsicEra.ts @@ -16,9 +16,7 @@ export default class ExtrinsicEra extends U8a { } static decodeExtrinsicEra (value?: AnyU8a): Uint8Array { - if (value instanceof U8a) { - return value.raw; - } else if (value) { + if (value) { const u8a = u8aToU8a(value); // If we have a zero byte, it is immortal (1 byte in length), otherwise we have diff --git a/packages/types/src/ExtrinsicSignature.ts b/packages/types/src/ExtrinsicSignature.ts index 27b09fbb61..7eb274b3c7 100644 --- a/packages/types/src/ExtrinsicSignature.ts +++ b/packages/types/src/ExtrinsicSignature.ts @@ -8,7 +8,6 @@ import { AnyNumber, AnyU8a } from './types'; import { isU8a, u8aConcat } from '@polkadot/util'; import Struct from './codec/Struct'; -import U8a from './codec/U8a'; import Address from './Address'; import ExtrinsicEra from './ExtrinsicEra'; import Method from './Method'; @@ -35,7 +34,7 @@ const BIT_VERSION = 0b0000001; // 8 bytes: The Transaction Index of the signing account // 1/2 bytes: The Transaction Era export default class ExtrinsicSignature extends Struct { - constructor (value?: ExtrinsicSignatureValue | U8a | Uint8Array) { + constructor (value?: ExtrinsicSignatureValue | Uint8Array) { super({ signer: Address, signature: Signature, @@ -49,8 +48,6 @@ export default class ExtrinsicSignature extends Struct { return {}; } else if (value instanceof Struct) { return value.raw; - } else if (value instanceof U8a) { - return ExtrinsicSignature.decodeExtrinsicSignature(value.raw); } else if (isU8a(value)) { const version = value[0]; diff --git a/packages/types/src/Method.ts b/packages/types/src/Method.ts index 550b329f88..0a7feb837f 100644 --- a/packages/types/src/Method.ts +++ b/packages/types/src/Method.ts @@ -6,7 +6,6 @@ import { ExtrinsicFunction, Extrinsics } from '@polkadot/extrinsics/types'; import { assert, isHex, isObject, isU8a } from '@polkadot/util'; import Base from './codec/Base'; -import U8a from './codec/U8a'; import { AnyU8a, Constructor } from './types'; import { FunctionMetadata, FunctionArgumentMetadata } from './Metadata'; import { getTypeDef, getTypeClass } from './codec/createType'; @@ -68,10 +67,8 @@ export default class Method extends Struct { * @param _meta - Metadata to use, so that `injectExtrinsics` lookup is not * necessary. */ - private static decodeMethod (value: DecodedMethod | U8a | Uint8Array | string, _meta?: FunctionMetadata): DecodedMethod { - if (value instanceof U8a) { - return Method.decodeMethod(value.raw); - } else if (isHex(value)) { + private static decodeMethod (value: DecodedMethod | Uint8Array | string, _meta?: FunctionMetadata): DecodedMethod { + if (isHex(value)) { return Method.decodeMethod(value, _meta); } else if (isU8a(value)) { // The first 2 bytes are the callIndex diff --git a/packages/types/src/Moment.ts b/packages/types/src/Moment.ts index 3f87953152..fbc6cf6224 100644 --- a/packages/types/src/Moment.ts +++ b/packages/types/src/Moment.ts @@ -6,7 +6,6 @@ import BN from 'bn.js'; import { bnToBn, bnToHex, bnToU8a, isString, isU8a, u8aToBn } from '@polkadot/util'; import Base from './codec/Base'; -import U8a from './codec/U8a'; import UInt, { UIntBitLength } from './codec/UInt'; import { AnyNumber } from './types'; @@ -30,8 +29,6 @@ export default class Moment extends Base { return new Date(Math.ceil(value.getTime() / 1000) * 1000); } else if (value instanceof UInt) { value = value.toBn(); - } else if (value instanceof U8a) { - return Moment.decodeMoment(value.raw); } else if (isU8a(value)) { value = u8aToBn(value.subarray(0, BITLENGTH / 8), true); } else if (isString(value)) { diff --git a/packages/types/src/StorageKey.ts b/packages/types/src/StorageKey.ts index 1eeaaae47b..f53ce1fd74 100644 --- a/packages/types/src/StorageKey.ts +++ b/packages/types/src/StorageKey.ts @@ -6,7 +6,6 @@ import { AnyU8a } from './types'; import { isFunction } from '@polkadot/util'; -import U8a from './codec/U8a'; import Bytes from './Bytes'; import { StorageFunctionMetadata } from './Metadata'; @@ -38,8 +37,6 @@ export default class StorageKey extends Bytes { if (isFunction(fn)) { return fn(arg); } - } else if (value instanceof U8a) { - return StorageKey.decodeStorageKey(value.raw); } return value as Uint8Array; diff --git a/packages/types/src/Text.ts b/packages/types/src/Text.ts index 003507ab8e..72ac20cb59 100644 --- a/packages/types/src/Text.ts +++ b/packages/types/src/Text.ts @@ -7,7 +7,6 @@ import { isFunction, isString, stringToU8a, u8aToString, u8aConcat } from '@polk import { AnyU8a } from '@polkadot/types/types'; import Base from './codec/Base'; import Compact, { DEFAULT_LENGTH_BITS } from './codec/Compact'; -import U8a from './codec/U8a'; // This is a string wrapper, along with the length. It is used both for strings as well // as stuff like documentation. @@ -33,8 +32,6 @@ export default class Text extends Base { const [offset, length] = Compact.decodeU8a(value, DEFAULT_LENGTH_BITS); return u8aToString(value.subarray(offset, offset + length.toNumber())); - } else if (value instanceof U8a) { - return Text.decodeText(value.raw); } else if (isFunction(value.toString)) { return value.toString(); } diff --git a/packages/types/src/codec/Compact.ts b/packages/types/src/codec/Compact.ts index d1ab1cef32..8fef4a395f 100644 --- a/packages/types/src/codec/Compact.ts +++ b/packages/types/src/codec/Compact.ts @@ -7,7 +7,6 @@ import { bnToBn, bnToU8a, hexToBn, isBn, isHex, isNumber, isString, isU8a, u8aTo import { AnyNumber, Constructor } from '../types'; import Base from './Base'; -import U8a from './U8a'; import UInt, { UIntBitLength } from './UInt'; import Moment from '../Moment'; @@ -64,9 +63,7 @@ export default class Compact extends Base { } static decodeCompact (Type: Constructor, value: AnyNumber): Moment | UInt { - if (value instanceof U8a) { - return Compact.decodeCompact(Type, value.raw); - } else if (isString(value)) { + if (isString(value)) { return new Type( isHex(value) ? hexToBn(value) diff --git a/packages/types/src/codec/Enum.ts b/packages/types/src/codec/Enum.ts index da5659ad93..53582ed55e 100644 --- a/packages/types/src/codec/Enum.ts +++ b/packages/types/src/codec/Enum.ts @@ -5,7 +5,6 @@ import { isU8a } from '@polkadot/util'; import Base from './Base'; -import U8a from './U8a'; type EnumDef = { [index: number]: string @@ -21,7 +20,7 @@ type EnumDef = { export default class Enum extends Base { private _enum: EnumDef; - constructor (def: EnumDef, value: Enum | U8a | Uint8Array | number = 0) { + constructor (def: EnumDef, value: Enum | Uint8Array | number = 0) { super( Enum.decodeEnum(value) ); @@ -29,11 +28,9 @@ export default class Enum extends Base { this._enum = def; } - static decodeEnum (value: Enum | U8a | Uint8Array | number = 0): number { + static decodeEnum (value: Enum | Uint8Array | number = 0): number { if (value instanceof Enum) { return value.raw; - } else if (value instanceof U8a) { - return Enum.decodeEnum(value.raw); } else if (isU8a(value)) { return value[0]; } else { diff --git a/packages/types/src/codec/EnumType.ts b/packages/types/src/codec/EnumType.ts index d8734fe2b6..56cace92ba 100644 --- a/packages/types/src/codec/EnumType.ts +++ b/packages/types/src/codec/EnumType.ts @@ -5,7 +5,6 @@ import { isNumber, isObject, isU8a, isUndefined, u8aConcat } from '@polkadot/util'; import Base from './Base'; -import U8a from './U8a'; import Null from '../Null'; import { Constructor } from '../types'; @@ -52,9 +51,7 @@ export default class EnumType extends Base> { } // Or else, we just look at `value` - if (value instanceof U8a) { - return EnumType.decodeEnumType(def, value.raw, index); - } else if (isU8a(value)) { + if (isU8a(value)) { return { index: value[0], value: new def[value[0]](value.subarray(1)) }; } else if (isNumber(value) && !isUndefined(def[value])) { return { index: value, value: new def[value]() }; diff --git a/packages/types/src/codec/Set.ts b/packages/types/src/codec/Set.ts index bae8cca29f..bc56361bca 100644 --- a/packages/types/src/codec/Set.ts +++ b/packages/types/src/codec/Set.ts @@ -5,7 +5,6 @@ import { isU8a, isUndefined } from '@polkadot/util'; import Base from './Base'; -import U8a from './U8a'; type SetValues = { [index: string]: number @@ -18,7 +17,7 @@ type SetValues = { export default class Set extends Base> { private _setValues: SetValues; - constructor (setValues: SetValues, value?: U8a | Array | Uint8Array | number) { + constructor (setValues: SetValues, value?: Array | Uint8Array | number) { super( Set.decodeSet(setValues, value) ); @@ -26,10 +25,8 @@ export default class Set extends Base> { this._setValues = setValues; } - static decodeSet (setValues: SetValues, value: U8a | Array | Uint8Array | number = 0): Array { - if (value instanceof U8a) { - return Set.decodeSet(setValues, value.raw); - } else if (isU8a(value)) { + static decodeSet (setValues: SetValues, value: Array | Uint8Array | number = 0): Array { + if (isU8a(value)) { return Set.decodeSet(setValues, value[0]); } else if (Array.isArray(value)) { return value.reduce((result, value) => { diff --git a/packages/types/src/codec/Struct.ts b/packages/types/src/codec/Struct.ts index 2444297d8d..f2144d6a18 100644 --- a/packages/types/src/codec/Struct.ts +++ b/packages/types/src/codec/Struct.ts @@ -5,7 +5,6 @@ import { hexToU8a, isHex, isObject, isU8a, u8aConcat, u8aToHex } from '@polkadot/util'; import Base from './Base'; -import U8a from './U8a'; import { Codec, Constructor, ConstructorDef } from '../types'; // A Struct defines an Object with key/values - where the values are Base values. It removes @@ -22,7 +21,7 @@ export default class Struct< V extends { [K in keyof S]: any } = { [K in keyof S]: any }, // type names, mapped by key, name of Class in S E extends { [K in keyof S]: string } = { [K in keyof S]: string } -> extends Map implements Codec { + > extends Map implements Codec { public raw: Map; // FIXME Remove this once we convert all types out of Base protected _jsonMap: Map; protected _Types: E; @@ -66,12 +65,10 @@ export default class Struct< S extends ConstructorDef, _, T extends { [K in keyof S]: Base } - > (Types: S, value: any, jsonMap: Map): T { + > (Types: S, value: any, jsonMap: Map): T { // l.debug(() => ['Struct.decode', { Types, value }]); - if (value instanceof U8a) { - return Struct.decodeStruct(Types, value.raw, jsonMap); - } else if (isHex(value)) { + if (isHex(value)) { return Struct.decodeStruct(Types, hexToU8a(value as string), jsonMap); } else if (!value) { return {} as T; @@ -115,7 +112,7 @@ export default class Struct< static with< S extends ConstructorDef - > (Types: S): Constructor> { + > (Types: S): Constructor> { return class extends Struct { constructor (value?: any, jsonMap?: Map) { super(Types, value, jsonMap); diff --git a/packages/types/src/codec/U8a.spec.js b/packages/types/src/codec/U8a.spec.ts similarity index 69% rename from packages/types/src/codec/U8a.spec.js rename to packages/types/src/codec/U8a.spec.ts index 332f4541bc..c35d5d97fd 100644 --- a/packages/types/src/codec/U8a.spec.js +++ b/packages/types/src/codec/U8a.spec.ts @@ -2,28 +2,29 @@ // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. +import { CodecTo } from '../types'; import U8a from './U8a'; -const testDecode = (type, input, expected) => +const testDecode = (type: string, input: any, expected: string) => it(`can decode from ${type}`, () => { const e = new U8a(input); expect(e.toString()).toBe(expected); }); -const testEncode = (to, expected) => +const testEncode = (to: CodecTo, expected: any) => it(`can encode ${to}`, () => { const e = new U8a([1, 2, 3, 4, 5]); expect(e[to]()).toEqual(expected); }); describe('U8a', () => { - let u8a; + let u8a: U8a; beforeEach(() => { u8a = new U8a([1, 2, 3, 4, 5]); }); - testDecode('Array', [1, 2, 3, 4, 5], '0x0102030405') + testDecode('Array', [1, 2, 3, 4, 5], '0x0102030405'); testDecode('hex', '0x0102030405', '0x0102030405'); testDecode('U8a', new Uint8Array([1, 2, 3, 4, 5]), '0x0102030405'); testDecode('Uint8Array', Uint8Array.from([1, 2, 3, 4, 5]), '0x0102030405'); @@ -34,12 +35,20 @@ describe('U8a', () => { testEncode('toU8a', Uint8Array.from([1, 2, 3, 4, 5])); it('contains the length of the elements', () => { - expect(u8a.length).toEqual(5); // eslint-disable-line + expect(u8a.length).toEqual(5); + }); + + it('correctly encodes length', () => { + expect(u8a.encodedLength).toEqual(5); }); it('allows wrapping of a pre-existing instance', () => { expect( new U8a(u8a).length - ).toEqual(5); // eslint-disable-line + ).toEqual(5); + }); + + it('implements subarray correctly', () => { + expect(u8a.subarray(1, 3).toString()).toEqual('0x0203'); }); }); diff --git a/packages/types/src/codec/U8a.ts b/packages/types/src/codec/U8a.ts index deefac328b..04ff2a2c44 100644 --- a/packages/types/src/codec/U8a.ts +++ b/packages/types/src/codec/U8a.ts @@ -4,40 +4,44 @@ import { isU8a, u8aToHex, u8aToU8a } from '@polkadot/util'; -import { AnyU8a } from '../types'; -import Base from './Base'; +import { AnyU8a, Codec } from '../types'; // A U8a. A basic wrapper around Uint8Array, with no frills and no fuss. It // wraps a Uint8Array. It does differ from other implementations wher it will // consume the full u8a as passed to it in U8a. As such it is meant to be // subclassed where the wrapper takes care of the actual lengths. -export default class U8a extends Base { - constructor (value: AnyU8a = new Uint8Array()) { - super( - U8a.decodeU8a(value) - ); +export default class U8a extends Uint8Array implements Codec { + public raw: Uint8Array; // FIXME Remove this once we convert all types out of Base + + constructor (value: AnyU8a | ArrayBuffer, byteOffset: number = 0, length?: number) { + // Uint8Array can be constructed with ArrayBuffer, in which case it has 1 + // or 2 more optional arguments. We handle this special case here. + // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array + if (value instanceof ArrayBuffer) { + super(value, byteOffset, length); + } else { + super( + U8a.decodeU8a(value) + ); + } + + this.raw = this; } - static decodeU8a (value: any): Uint8Array { + private static decodeU8a (value: any): Uint8Array { if (isU8a(value)) { return value; - } else if (value instanceof U8a) { - return value.raw; } else { return u8aToU8a(value); } } - get length (): number { - return this.raw.length; - } - get encodedLength (): number { return this.length; } toHex (): string { - return u8aToHex(this.raw); + return u8aToHex(this); } toJSON (): any { @@ -45,7 +49,7 @@ export default class U8a extends Base { } toU8a (isBare?: boolean): Uint8Array { - return this.raw; + return Uint8Array.from(this); } toString (): string { diff --git a/packages/types/src/codec/U8aFixed.spec.js b/packages/types/src/codec/U8aFixed.spec.ts similarity index 80% rename from packages/types/src/codec/U8aFixed.spec.js rename to packages/types/src/codec/U8aFixed.spec.ts index 912b9378dd..6d633e1973 100644 --- a/packages/types/src/codec/U8aFixed.spec.js +++ b/packages/types/src/codec/U8aFixed.spec.ts @@ -5,14 +5,18 @@ import U8aFixed from './U8aFixed'; describe('U8aFixed', () => { - let u8a; + let u8a: U8aFixed; beforeEach(() => { u8a = new U8aFixed([1, 2, 3, 4, 5, 6, 7, 8, 9, 10], 32); }); it('limits the length', () => { - expect(u8a.length).toEqual(4); // eslint-disable-line + expect(u8a.length).toEqual(4); + }); + + it('exposes the correct bitLength', () => { + expect(u8a.bitLength).toEqual(32); }); it('allows wrapping of a pre-existing instance', () => { diff --git a/packages/types/src/codec/U8aFixed.ts b/packages/types/src/codec/U8aFixed.ts index d40ce5627b..1d8d2e7f56 100644 --- a/packages/types/src/codec/U8aFixed.ts +++ b/packages/types/src/codec/U8aFixed.ts @@ -2,6 +2,8 @@ // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. +import { isString, isU8a, u8aToU8a } from '@polkadot/util'; + import { AnyU8a } from '../types'; import U8a from './U8a'; @@ -11,25 +13,23 @@ type BitLength = 8 | 16 | 32 | 64 | 128 | 256 | 512; // A U8a that manages a a sequence of bytes up to the specified bitLength. Not meant // to be used directly, rather is should be subclassed with the specific lengths. export default class U8aFixed extends U8a { - protected _bitLength: number; - constructor (value: AnyU8a = new Uint8Array(), bitLength: BitLength = 256) { - super(value); - - this._bitLength = bitLength; - - this._trim(); + super( + U8aFixed.decodeU8aFixed(value, bitLength) + ); } - private _trimLength (): number { - return this._bitLength / 8; + private static decodeU8aFixed (value: AnyU8a, bitLength: BitLength = 256): AnyU8a { + if (isU8a(value)) { + return value.subarray(0, bitLength / 8); + } else if (Array.isArray(value) || isString(value)) { + return U8aFixed.decodeU8aFixed(u8aToU8a(value), bitLength); + } + + return value; } - private _trim (): void { - this.raw = this.raw.subarray(0, this._trimLength()); - } - - get encodedLength (): number { - return this._trimLength(); + get bitLength () { + return this.length * 8; } } diff --git a/packages/types/src/codec/UInt.ts b/packages/types/src/codec/UInt.ts index f2e6fbfed5..12a4adf307 100644 --- a/packages/types/src/codec/UInt.ts +++ b/packages/types/src/codec/UInt.ts @@ -8,7 +8,6 @@ import BN from 'bn.js'; import { bnToBn, bnToHex, bnToU8a, hexToBn, isHex, isString, isU8a, u8aToBn } from '@polkadot/util'; import Base from './Base'; -import U8a from './U8a'; export type UIntBitLength = 8 | 16 | 32 | 64 | 128 | 256; @@ -36,8 +35,6 @@ export default class UInt extends Base { static decodeUInt (value: AnyNumber, bitLength: UIntBitLength): BN { if (value instanceof UInt) { return value.raw; - } else if (value instanceof U8a) { - return UInt.decodeUInt(value.raw, bitLength); } else if (isHex(value)) { return hexToBn(value); } else if (isU8a(value)) { diff --git a/packages/types/src/codec/Vector.ts b/packages/types/src/codec/Vector.ts index 3405459115..b8d2d02232 100644 --- a/packages/types/src/codec/Vector.ts +++ b/packages/types/src/codec/Vector.ts @@ -6,7 +6,6 @@ import { u8aConcat, u8aToU8a } from '@polkadot/util'; import Base from './Base'; import Compact, { DEFAULT_LENGTH_BITS } from './Compact'; -import U8a from './U8a'; import { Constructor } from '../types'; // This manages codec arrays. Intrernally it keeps track of the length (as decoded) and allows @@ -19,7 +18,7 @@ export default class Vector< > extends Base> { private _Type: Constructor; - constructor (Type: Constructor, value: Vector | U8a | Uint8Array | string | Array = [] as Array) { + constructor (Type: Constructor, value: Vector | Uint8Array | string | Array = [] as Array) { super( Vector.decodeVector(Type, value) ); @@ -27,7 +26,7 @@ export default class Vector< this._Type = Type; } - static decodeVector (Type: Constructor, value: Vector | U8a | Uint8Array | string | Array): Array { + static decodeVector (Type: Constructor, value: Vector | Uint8Array | string | Array): Array { if (Array.isArray(value)) { return value.map((entry) => entry instanceof Type @@ -38,9 +37,7 @@ export default class Vector< return Vector.decodeVector(Type, value.raw); } - const u8a = value instanceof U8a - ? value.raw - : u8aToU8a(value); + const u8a = u8aToU8a(value); let [offset, _length] = Compact.decodeU8a(u8a, DEFAULT_LENGTH_BITS); const length = _length.toNumber(); diff --git a/packages/types/src/types.d.ts b/packages/types/src/types.d.ts index a3c9ecddcf..9779261ee2 100644 --- a/packages/types/src/types.d.ts +++ b/packages/types/src/types.d.ts @@ -6,11 +6,13 @@ import BN from 'bn.js'; import * as Classes from './index'; import Base from './codec/Base'; -import { U8a, UInt } from './codec'; +import { UInt } from './codec'; -export type AnyNumber = U8a | UInt | BN | Uint8Array | number | string; +export type AnyNumber = UInt | BN | Uint8Array | number | string; -export type AnyU8a = U8a | Uint8Array | Array | string; +export type AnyString = string | String; + +export type AnyU8a = Uint8Array | Array | string; export interface Codec { encodedLength: number; From d8c3e7298e2404def691bd94a2c354dd547b9f68 Mon Sep 17 00:00:00 2001 From: Travis CI <> Date: Tue, 13 Nov 2018 11:53:56 +0000 Subject: [PATCH 2/2] [CI Skip] 0.31.112 --- docs/GLOSSARY.html | 2 +- docs/METHODS_EVENTS.html | 2 +- docs/METHODS_EXTRINSICS.html | 2 +- docs/METHODS_RPC.html | 2 +- docs/METHODS_STORAGE.html | 2 +- docs/api-observable/classes/_base_.apibase.md | 18 +- .../classes/_calls_.apicalls.md | 96 +-- .../classes/_classes_.rxproposal.md | 28 +- .../classes/_classes_.rxproposaldeposits.md | 26 +- .../classes/_classes_.rxreferendum.md | 30 +- .../classes/_combined_.apicombined.md | 144 ++-- docs/api-observable/classes/_index_.api.md | 144 ++-- .../classes/_queries_.apiqueries.md | 80 +- docs/api/classes/_base_.apibase.md | 16 +- .../_promise_combinator_.combinator.md | 2 +- .../classes/_promise_index_.apipromise.html | 24 +- .../api/classes/_promise_index_.apipromise.md | 22 +- ...mittableextrinsic_.submittableextrinsic.md | 46 +- docs/api/classes/_rx_index_.apirx.html | 24 +- docs/api/classes/_rx_index_.apirx.md | 22 +- ...mittableextrinsic_.submittableextrinsic.md | 46 +- docs/api/index.html | 2 +- docs/api/modules/_promise_combinator_.md | 4 +- .../promise/01_simple_connect/index.html | 2 +- .../promise/02_listen_to_blocks/index.html | 2 +- .../03_listen_to_balance_change/index.html | 2 +- .../promise/05_read_storage/index.html | 2 +- .../promise/07_transfer_dots/index.html | 2 +- docs/examples/promise/index.html | 2 +- docs/index.html | 2 +- docs/rpc-core/classes/_index_.rpc.md | 14 +- .../classes/_coder_index_.rpccoder.md | 8 +- .../classes/_http_index_.httpprovider.html | 14 +- .../classes/_http_index_.httpprovider.md | 12 +- .../rpc-provider/classes/_mock_index_.mock.md | 16 +- .../classes/_ws_index_.wsprovider.html | 16 +- .../classes/_ws_index_.wsprovider.md | 14 +- docs/rpc-provider/index.html | 2 +- docs/rpc-rx/classes/_index_.rpcrx.md | 14 +- .../type-extrinsics/modules/_frommetadata_.md | 2 +- .../modules/_utils_createunchecked_.md | 2 +- docs/type-jsonrpc/modules/_create_method_.md | 2 +- docs/type-jsonrpc/modules/_create_param_.md | 2 +- ...utils_createfunction_.createitemoptions.md | 4 +- docs/type-storage/modules/_frommetadata_.md | 2 +- docs/type-storage/modules/_storage_.md | 4 +- docs/type-storage/modules/_substrate_.md | 12 +- .../modules/_utils_createfunction_.md | 2 +- docs/types/SUMMARY.md | 2 + docs/types/classes/_accountid_.accountid.md | 721 +++++++++++++++-- .../classes/_accountindex_.accountindex.md | 52 +- docs/types/classes/_address_.address.md | 18 +- .../classes/_authorityid_.authorityid.md | 723 ++++++++++++++++-- docs/types/classes/_balance_.balance.md | 44 +- .../classes/_bft_.bftauthoritysignature.md | 26 +- docs/types/classes/_bft_.bfthashsignature.md | 26 +- docs/types/classes/_bft_.justification.md | 28 +- docs/types/classes/_block_.block.md | 28 +- .../classes/_blocknumber_.blocknumber.md | 44 +- docs/types/classes/_bool_.bool.md | 20 +- docs/types/classes/_bytes_.bytes.md | 710 +++++++++++++++-- docs/types/classes/_codec_base_.base.md | 14 +- docs/types/classes/_codec_compact_.compact.md | 32 +- docs/types/classes/_codec_enum_.enum.md | 24 +- .../classes/_codec_enumtype_.enumtype.md | 24 +- docs/types/classes/_codec_option_.option.md | 20 +- docs/types/classes/_codec_set_.set.md | 30 +- docs/types/classes/_codec_struct_.struct.md | 22 +- docs/types/classes/_codec_tuple_.tuple.md | 22 +- docs/types/classes/_codec_u8a_.u8a.md | 710 ++++++++++++++++- .../classes/_codec_u8afixed_.u8afixed.md | 704 ++++++++++++++++- docs/types/classes/_codec_uint_.uint.md | 44 +- docs/types/classes/_codec_vector_.vector.md | 42 +- docs/types/classes/_data_.data.md | 705 +++++++++++++++-- docs/types/classes/_digest_.digest.md | 24 +- docs/types/classes/_digest_.digestitem.md | 24 +- docs/types/classes/_event_.event.md | 46 +- .../classes/_eventrecord_.eventrecord.md | 26 +- docs/types/classes/_extrinsic_.extrinsic.md | 44 +- .../classes/_extrinsicera_.extrinsicera.md | 715 +++++++++++++++-- docs/types/classes/_extrinsics_.extrinsics.md | 42 +- ..._extrinsicsignature_.extrinsicsignature.md | 42 +- .../classes/_extrinsicstatus_.broadcast.md | 42 +- .../classes/_extrinsicstatus_.dropped.md | 12 +- .../_extrinsicstatus_.extrinsicstatus.md | 24 +- .../classes/_extrinsicstatus_.finalised.md | 706 ++++++++++++++++- .../classes/_extrinsicstatus_.usurped.md | 706 ++++++++++++++++- docs/types/classes/_gas_.gas.md | 44 +- docs/types/classes/_h256_.h256.md | 706 ++++++++++++++++- docs/types/classes/_h512_.h512.md | 706 ++++++++++++++++- docs/types/classes/_hash_.hash.md | 706 ++++++++++++++++- docs/types/classes/_header_.header.md | 34 +- docs/types/classes/_keyvalue_.keyvalue.md | 26 +- .../classes/_keyvalue_.keyvalueoption.md | 26 +- docs/types/classes/_metadata_.callmetadata.md | 26 +- .../types/classes/_metadata_.eventmetadata.md | 28 +- .../_metadata_.functionargumentmetadata.md | 26 +- .../classes/_metadata_.functionmetadata.md | 30 +- .../classes/_metadata_.modulemetadata.md | 26 +- .../classes/_metadata_.outerdispatchcall.md | 28 +- .../_metadata_.outerdispatchmetadata.md | 26 +- .../classes/_metadata_.outereventmetadata.md | 26 +- .../_metadata_.outereventmetadataevent.md | 26 +- .../classes/_metadata_.runtimemetadata.md | 32 +- .../_metadata_.runtimemodulemetadata.md | 28 +- .../_metadata_.storagefunctionmetadata.md | 30 +- .../_metadata_.storagefunctionmodifier.md | 20 +- .../classes/_metadata_.storagefunctiontype.md | 30 +- .../_metadata_.storagefunctiontype_map.md | 26 +- .../classes/_metadata_.storagemetadata.md | 26 +- docs/types/classes/_method_.method.md | 38 +- .../_misbehaviorreport_.bftatreport.md | 28 +- .../_misbehaviorreport_.bftdoublecommit.md | 28 +- .../_misbehaviorreport_.bftdoubleprepare.md | 28 +- .../_misbehaviorreport_.misbehaviorkind.md | 24 +- .../_misbehaviorreport_.misbehaviorreport.md | 30 +- docs/types/classes/_moment_.moment.md | 24 +- .../_newaccountoutcome_.newaccountoutcome.md | 20 +- docs/types/classes/_nonce_.index.md | 44 +- docs/types/classes/_null_.null.md | 12 +- docs/types/classes/_origin_.origin.md | 12 +- .../classes/_parachainid_.parachainid.md | 44 +- .../_pendingextrinsics_.pendingextrinsics.md | 42 +- docs/types/classes/_perbill_.perbill.md | 44 +- docs/types/classes/_permill_.permill.md | 44 +- docs/types/classes/_propindex_.propindex.md | 44 +- docs/types/classes/_proposal_.proposal.md | 38 +- .../classes/_proposalindex_.proposalindex.md | 44 +- .../_referendumindex_.referendumindex.md | 44 +- .../_runtimeversion_.runtimeversion.md | 34 +- docs/types/classes/_signature_.signature.md | 706 ++++++++++++++++- .../_signaturepayload_.signaturepayload.md | 36 +- .../classes/_signedblock_.signedblock.md | 26 +- .../_storagechangeset_.storagechangeset.md | 26 +- .../classes/_storagedata_.storagedata.md | 714 +++++++++++++++-- docs/types/classes/_storagekey_.storagekey.md | 720 +++++++++++++++-- docs/types/classes/_text_.text.md | 16 +- docs/types/classes/_type_.type.md | 16 +- docs/types/classes/_u128_.u128.md | 44 +- docs/types/classes/_u16_.u16.md | 44 +- docs/types/classes/_u256_.u256.md | 44 +- docs/types/classes/_u32_.u32.md | 44 +- docs/types/classes/_u64_.u64.md | 44 +- docs/types/classes/_u8_.u8.md | 44 +- .../_validatorprefs_.validatorprefs.md | 26 +- docs/types/classes/_voteindex_.voteindex.md | 44 +- .../classes/_votethreshold_.votethreshold.md | 20 +- .../enums/_codec_createtype_.typedefinfo.md | 8 +- .../_storagekey_.storagefunction.md | 10 +- docs/types/modules/_accountindex_.md | 2 +- docs/types/modules/_address_.md | 2 +- docs/types/modules/_bft_.md | 6 +- docs/types/modules/_block_.md | 2 +- docs/types/modules/_codec_base_.md | 2 +- docs/types/modules/_codec_compact_.md | 2 +- docs/types/modules/_codec_createtype_.md | 10 +- docs/types/modules/_codec_u8a_spec_.md | 2 + docs/types/modules/_codec_u8afixed_spec_.md | 2 + docs/types/modules/_codec_uint_.md | 4 +- docs/types/modules/_header_.md | 2 +- docs/types/modules/_keyvalue_.md | 2 +- lerna.json | 2 +- package.json | 2 +- packages/api-observable/package.json | 10 +- packages/api/package.json | 10 +- packages/rpc-core/package.json | 6 +- packages/rpc-provider/package.json | 4 +- packages/rpc-rx/package.json | 6 +- packages/type-extrinsics/package.json | 2 +- packages/type-jsonrpc/package.json | 2 +- packages/type-storage/package.json | 4 +- packages/types/package.json | 2 +- 172 files changed, 11817 insertions(+), 2479 deletions(-) create mode 100644 docs/types/modules/_codec_u8a_spec_.md create mode 100644 docs/types/modules/_codec_u8afixed_spec_.md diff --git a/docs/GLOSSARY.html b/docs/GLOSSARY.html index dd14b3d1b6..8bf64974ee 100644 --- a/docs/GLOSSARY.html +++ b/docs/GLOSSARY.html @@ -426,7 +426,7 @@ diff --git a/docs/METHODS_EVENTS.html b/docs/METHODS_EVENTS.html index a322404f40..71b5736f48 100644 --- a/docs/METHODS_EVENTS.html +++ b/docs/METHODS_EVENTS.html @@ -600,7 +600,7 @@ diff --git a/docs/METHODS_EXTRINSICS.html b/docs/METHODS_EXTRINSICS.html index f68ad78a1f..1b96db76c2 100644 --- a/docs/METHODS_EXTRINSICS.html +++ b/docs/METHODS_EXTRINSICS.html @@ -546,7 +546,7 @@ diff --git a/docs/METHODS_RPC.html b/docs/METHODS_RPC.html index df4711dfae..aa0f9474bc 100644 --- a/docs/METHODS_RPC.html +++ b/docs/METHODS_RPC.html @@ -556,7 +556,7 @@ diff --git a/docs/METHODS_STORAGE.html b/docs/METHODS_STORAGE.html index 6c6567df52..0f91a54eb6 100644 --- a/docs/METHODS_STORAGE.html +++ b/docs/METHODS_STORAGE.html @@ -887,7 +887,7 @@ diff --git a/docs/api-observable/classes/_base_.apibase.md b/docs/api-observable/classes/_base_.apibase.md index 3b82a990ce..d221f88365 100644 --- a/docs/api-observable/classes/_base_.apibase.md +++ b/docs/api-observable/classes/_base_.apibase.md @@ -14,7 +14,7 @@ ⊕ **new ApiBase**(api: *`RpcRxInterface`*): [ApiBase](_base_.apibase.md) -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L34)* **Parameters:** @@ -34,7 +34,7 @@ ___ **● whenReady**: *`Observable`<`boolean`>* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L34)* ___ @@ -43,7 +43,7 @@ ___ **● extrinsics**: *`Extrinsics`* = extrinsicsStatic -*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L42)* +*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L42)* ___ @@ -52,7 +52,7 @@ ___ **● storage**: *`Storage`* = storageStatic -*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L43)* +*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L43)* ___ @@ -64,7 +64,7 @@ ___ getgenesisHash(): `Hash` -*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L88)* +*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L88)* **Returns:** `Hash` @@ -78,7 +78,7 @@ ___ ▸ **isConnected**(): `Observable`<`boolean`> -*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L92)* +*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L92)* **Returns:** `Observable`<`boolean`> @@ -89,7 +89,7 @@ ___ ▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`> -*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L96)* +*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L96)* **Type parameters:** @@ -110,7 +110,7 @@ ___ ▸ **rawStorage**<`T`>(key: * `Uint8Array` | `StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`< `T` | `undefined`> -*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L109)* +*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L109)* **Type parameters:** @@ -131,7 +131,7 @@ ___ ▸ **rawStorageMulti**<`T`>(...keys: *`Array`< `Uint8Array` | [`StorageFunction`] | [`StorageFunction`, `any`]>*): `Observable`<`T`> -*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L126)* +*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L126)* **Type parameters:** diff --git a/docs/api-observable/classes/_calls_.apicalls.md b/docs/api-observable/classes/_calls_.apicalls.md index a07ba3a8ff..f0718985dd 100644 --- a/docs/api-observable/classes/_calls_.apicalls.md +++ b/docs/api-observable/classes/_calls_.apicalls.md @@ -18,7 +18,7 @@ *Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L34)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L34)* ___ @@ -51,7 +51,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)* -*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L42)* +*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L42)* ___ @@ -62,7 +62,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)* -*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L43)* +*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L43)* ___ @@ -76,7 +76,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L88)* +*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L88)* **Returns:** `Hash` @@ -92,7 +92,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)* -*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L21)* +*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L21)* **Parameters:** @@ -111,7 +111,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)* -*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L25)* +*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L25)* **Parameters:** @@ -130,7 +130,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)* -*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L29)* +*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L29)* **Parameters:** @@ -147,7 +147,7 @@ ___ ▸ **bestNumber**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L13)* +*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L13)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -160,7 +160,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)* -*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L37)* +*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L37)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -173,7 +173,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)* -*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L33)* +*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L33)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -184,7 +184,7 @@ ___ ▸ **chain**(): `Observable`< `Text` | `undefined`> -*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L25)* +*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L25)* **Returns:** `Observable`< `Text` | `undefined`> @@ -197,7 +197,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)* -*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L41)* +*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L41)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -210,7 +210,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)* -*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L45)* +*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L45)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -223,7 +223,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)* -*Defined in [Queries.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L135)* +*Defined in [Queries.ts:135](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L135)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -236,7 +236,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)* -*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L160)* +*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L160)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -249,7 +249,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)* -*Defined in [Queries.ts:139](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L139)* +*Defined in [Queries.ts:139](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L139)* **Returns:** `Observable`<`RxFees`> @@ -262,7 +262,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)* -*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L49)* +*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L49)* **Parameters:** @@ -279,7 +279,7 @@ ___ ▸ **getBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` | `undefined`> -*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L29)* +*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L29)* **Parameters:** @@ -298,7 +298,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* -*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L92)* +*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L92)* **Returns:** `Observable`<`boolean`> @@ -311,7 +311,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)* -*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L63)* +*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L63)* **Returns:** `Observable`< `AccountIndex` | `undefined`> @@ -324,7 +324,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)* -*Defined in [Queries.ts:67](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L67)* +*Defined in [Queries.ts:67](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L67)* **Parameters:** @@ -343,7 +343,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)* -*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L80)* +*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L80)* **Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> @@ -356,7 +356,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* -*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L96)* +*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L96)* **Type parameters:** @@ -379,7 +379,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* -*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L109)* +*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L109)* **Type parameters:** @@ -402,7 +402,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* -*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L126)* +*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L126)* **Type parameters:** @@ -424,7 +424,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)* -*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L100)* +*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L100)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -437,7 +437,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)* -*Defined in [Queries.ts:104](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L104)* +*Defined in [Queries.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L104)* **Parameters:** @@ -456,7 +456,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)* -*Defined in [Queries.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L117)* +*Defined in [Queries.ts:117](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L117)* **Parameters:** @@ -476,7 +476,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)* -*Defined in [Queries.ts:121](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L121)* +*Defined in [Queries.ts:121](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L121)* **Parameters:** @@ -495,7 +495,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)* -*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L172)* +*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L172)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -508,7 +508,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)* -*Defined in [Queries.ts:176](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L176)* +*Defined in [Queries.ts:176](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L176)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -521,7 +521,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)* -*Defined in [Queries.ts:180](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L180)* +*Defined in [Queries.ts:180](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L180)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -534,7 +534,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)* -*Defined in [Queries.ts:184](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L184)* +*Defined in [Queries.ts:184](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L184)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -547,7 +547,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)* -*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L164)* +*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L164)* **Returns:** `Observable`< `Perbill` | `undefined`> @@ -560,7 +560,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)* -*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L168)* +*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L168)* **Returns:** `Observable`< `Balance` | `undefined`> @@ -573,7 +573,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)* -*Defined in [Queries.ts:192](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L192)* +*Defined in [Queries.ts:192](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L192)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -586,7 +586,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)* -*Defined in [Queries.ts:188](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L188)* +*Defined in [Queries.ts:188](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L188)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -599,7 +599,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)* -*Defined in [Queries.ts:206](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L206)* +*Defined in [Queries.ts:206](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L206)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -612,7 +612,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)* -*Defined in [Queries.ts:234](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L234)* +*Defined in [Queries.ts:234](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L234)* **Parameters:** @@ -631,7 +631,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)* -*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L220)* +*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L220)* **Parameters:** @@ -648,7 +648,7 @@ ___ ▸ **submitAndWatchExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `ExtrinsicStatus` | `undefined`> -*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L51)* +*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L51)* **Parameters:** @@ -665,7 +665,7 @@ ___ ▸ **submitExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `Hash` | `undefined`> -*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L47)* +*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L47)* **Parameters:** @@ -682,7 +682,7 @@ ___ ▸ **subscribeNewHead**(): `Observable`< `Header` | `undefined`> -*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L33)* +*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L33)* **Returns:** `Observable`< `Header` | `undefined`> @@ -695,7 +695,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)* -*Defined in [Queries.ts:238](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L238)* +*Defined in [Queries.ts:238](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L238)* **Returns:** `Observable`<`Array`<`EventRecord`>> @@ -706,7 +706,7 @@ ___ ▸ **systemName**(): `Observable`< `Text` | `undefined`> -*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L39)* +*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L39)* **Returns:** `Observable`< `Text` | `undefined`> @@ -717,7 +717,7 @@ ___ ▸ **systemVersion**(): `Observable`< `Text` | `undefined`> -*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L43)* +*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L43)* **Returns:** `Observable`< `Text` | `undefined`> @@ -730,7 +730,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)* -*Defined in [Queries.ts:252](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L252)* +*Defined in [Queries.ts:252](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L252)* **Returns:** `Observable`< `u32` | `undefined`> diff --git a/docs/api-observable/classes/_classes_.rxproposal.md b/docs/api-observable/classes/_classes_.rxproposal.md index c3b787d23e..60ce6055ed 100644 --- a/docs/api-observable/classes/_classes_.rxproposal.md +++ b/docs/api-observable/classes/_classes_.rxproposal.md @@ -25,7 +25,7 @@ *Overrides Struct.__constructor* -*Defined in [classes.ts:12](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/classes.ts#L12)* +*Defined in [classes.ts:12](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/classes.ts#L12)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from Struct.raw* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getaddress(): `AccountId` -*Defined in [classes.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/classes.ts#L21)* +*Defined in [classes.ts:21](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/classes.ts#L21)* **Returns:** `AccountId` @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getid(): `PropIndex` -*Defined in [classes.ts:25](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/classes.ts#L25)* +*Defined in [classes.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/classes.ts#L25)* **Returns:** `PropIndex` @@ -129,7 +129,7 @@ ___ getproposal(): `Proposal` -*Defined in [classes.ts:29](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/classes.ts#L29)* +*Defined in [classes.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/classes.ts#L29)* **Returns:** `Proposal` @@ -246,7 +246,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -319,7 +319,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<`Base`> @@ -332,7 +332,7 @@ ___ *Inherited from Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -345,7 +345,7 @@ ___ *Inherited from Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -358,7 +358,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -371,7 +371,7 @@ ___ *Inherited from Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -405,7 +405,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/api-observable/classes/_classes_.rxproposaldeposits.md b/docs/api-observable/classes/_classes_.rxproposaldeposits.md index a24fa8589b..c8b6b00813 100644 --- a/docs/api-observable/classes/_classes_.rxproposaldeposits.md +++ b/docs/api-observable/classes/_classes_.rxproposaldeposits.md @@ -25,7 +25,7 @@ *Overrides Struct.__constructor* -*Defined in [classes.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/classes.ts#L36)* +*Defined in [classes.ts:36](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/classes.ts#L36)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from Struct.raw* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getaddresses(): `Vector`<`AccountId`> -*Defined in [classes.ts:44](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/classes.ts#L44)* +*Defined in [classes.ts:44](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/classes.ts#L44)* **Returns:** `Vector`<`AccountId`> @@ -105,7 +105,7 @@ ___ getbalance(): `Balance` -*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/classes.ts#L48)* +*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/classes.ts#L48)* **Returns:** `Balance` @@ -118,7 +118,7 @@ getencodedLength(): `number` *Inherited from Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -235,7 +235,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<`Base`> @@ -321,7 +321,7 @@ ___ *Inherited from Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/api-observable/classes/_classes_.rxreferendum.md b/docs/api-observable/classes/_classes_.rxreferendum.md index ebf9783a1f..fc7fd7c88e 100644 --- a/docs/api-observable/classes/_classes_.rxreferendum.md +++ b/docs/api-observable/classes/_classes_.rxreferendum.md @@ -25,7 +25,7 @@ *Overrides Struct.__constructor* -*Defined in [classes.ts:55](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/classes.ts#L55)* +*Defined in [classes.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/classes.ts#L55)* **Parameters:** @@ -59,7 +59,7 @@ ___ *Inherited from Struct.raw* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -84,7 +84,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -95,7 +95,7 @@ ___ getblockNumber(): `BlockNumber` -*Defined in [classes.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/classes.ts#L65)* +*Defined in [classes.ts:65](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/classes.ts#L65)* **Returns:** `BlockNumber` @@ -108,7 +108,7 @@ getencodedLength(): `number` *Inherited from Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -119,7 +119,7 @@ ___ getid(): `ReferendumIndex` -*Defined in [classes.ts:69](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/classes.ts#L69)* +*Defined in [classes.ts:69](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/classes.ts#L69)* **Returns:** `ReferendumIndex` @@ -130,7 +130,7 @@ ___ getproposal(): `Proposal` -*Defined in [classes.ts:73](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/classes.ts#L73)* +*Defined in [classes.ts:73](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/classes.ts#L73)* **Returns:** `Proposal` @@ -141,7 +141,7 @@ ___ getvoteThreshold(): `VoteThreshold` -*Defined in [classes.ts:77](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/classes.ts#L77)* +*Defined in [classes.ts:77](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/classes.ts#L77)* **Returns:** `VoteThreshold` @@ -258,7 +258,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -331,7 +331,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<`Base`> @@ -344,7 +344,7 @@ ___ *Inherited from Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -357,7 +357,7 @@ ___ *Inherited from Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -370,7 +370,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -383,7 +383,7 @@ ___ *Inherited from Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -417,7 +417,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/api-observable/classes/_combined_.apicombined.md b/docs/api-observable/classes/_combined_.apicombined.md index 677bccb4c4..d404c5f10b 100644 --- a/docs/api-observable/classes/_combined_.apicombined.md +++ b/docs/api-observable/classes/_combined_.apicombined.md @@ -18,7 +18,7 @@ *Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L34)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L34)* ___ @@ -51,7 +51,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)* -*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L42)* +*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L42)* ___ @@ -62,7 +62,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)* -*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L43)* +*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L43)* ___ @@ -76,7 +76,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L88)* +*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L88)* **Returns:** `Hash` @@ -90,7 +90,7 @@ ___ ▸ **accountIdAndIndex**(address?: * `AccountId` | `AccountIndex` | `string` | `null`*): `Observable`<[`AccountId` | `undefined`, `AccountIndex` | `undefined`]> -*Defined in [Combined.ts:81](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L81)* +*Defined in [Combined.ts:81](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L81)* **Parameters:** @@ -107,7 +107,7 @@ ___ ▸ **accountIdFromIndex**(_accountIndex: * `AccountIndex` | `string`*): `Observable`< `AccountId` | `undefined`> -*Defined in [Combined.ts:55](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L55)* +*Defined in [Combined.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L55)* **Parameters:** @@ -124,7 +124,7 @@ ___ ▸ **accountIndexFromId**(accountId: * `AccountId` | `string`*): `Observable`< `AccountIndex` | `undefined`> -*Defined in [Combined.ts:70](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L70)* +*Defined in [Combined.ts:70](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L70)* **Parameters:** @@ -141,7 +141,7 @@ ___ ▸ **accountIndexes**(): `Observable`<`object`> -*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L23)* +*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L23)* **Returns:** `Observable`<`object`> @@ -154,7 +154,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)* -*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L21)* +*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L21)* **Parameters:** @@ -173,7 +173,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)* -*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L25)* +*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L25)* **Parameters:** @@ -192,7 +192,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)* -*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L29)* +*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L29)* **Parameters:** @@ -211,7 +211,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)* -*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L13)* +*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L13)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -224,7 +224,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)* -*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L37)* +*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L37)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -237,7 +237,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)* -*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L33)* +*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L33)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -250,7 +250,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)* -*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L25)* +*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L25)* **Returns:** `Observable`< `Text` | `undefined`> @@ -263,7 +263,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)* -*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L41)* +*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L41)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -276,7 +276,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)* -*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L45)* +*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L45)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -287,7 +287,7 @@ ___ ▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`RxReferendumVote`>> -*Defined in [Combined.ts:139](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L139)* +*Defined in [Combined.ts:139](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L139)* **Parameters:** @@ -304,7 +304,7 @@ ___ ▸ **democracyVotersBalancesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Balance`>> -*Defined in [Combined.ts:184](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L184)* +*Defined in [Combined.ts:184](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L184)* **Parameters:** @@ -321,7 +321,7 @@ ___ ▸ **democracyVotersVotesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Bool`>> -*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L200)* +*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L200)* **Parameters:** @@ -340,7 +340,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)* -*Defined in [Queries.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L135)* +*Defined in [Queries.ts:135](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L135)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -351,7 +351,7 @@ ___ ▸ **eraBlockLength**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:211](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L211)* +*Defined in [Combined.ts:211](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L211)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -362,7 +362,7 @@ ___ ▸ **eraBlockProgress**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:226](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L226)* +*Defined in [Combined.ts:226](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L226)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -373,7 +373,7 @@ ___ ▸ **eraBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L249)* +*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L249)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -386,7 +386,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)* -*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L160)* +*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L160)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -399,7 +399,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)* -*Defined in [Queries.ts:139](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L139)* +*Defined in [Queries.ts:139](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L139)* **Returns:** `Observable`<`RxFees`> @@ -412,7 +412,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)* -*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L49)* +*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L49)* **Parameters:** @@ -431,7 +431,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)* -*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L29)* +*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L29)* **Parameters:** @@ -450,7 +450,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* -*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L92)* +*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L92)* **Returns:** `Observable`<`boolean`> @@ -463,7 +463,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)* -*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L63)* +*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L63)* **Returns:** `Observable`< `AccountIndex` | `undefined`> @@ -476,7 +476,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)* -*Defined in [Queries.ts:67](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L67)* +*Defined in [Queries.ts:67](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L67)* **Parameters:** @@ -493,7 +493,7 @@ ___ ▸ **publicProposalCount**(): `Observable`<`number`> -*Defined in [Combined.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L117)* +*Defined in [Combined.ts:117](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L117)* **Returns:** `Observable`<`number`> @@ -506,7 +506,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)* -*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L80)* +*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L80)* **Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> @@ -519,7 +519,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* -*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L96)* +*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L96)* **Type parameters:** @@ -542,7 +542,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* -*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L109)* +*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L109)* **Type parameters:** @@ -565,7 +565,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* -*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L126)* +*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L126)* **Type parameters:** @@ -587,7 +587,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)* -*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L100)* +*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L100)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -600,7 +600,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)* -*Defined in [Queries.ts:104](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L104)* +*Defined in [Queries.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L104)* **Parameters:** @@ -619,7 +619,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)* -*Defined in [Queries.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L117)* +*Defined in [Queries.ts:117](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L117)* **Parameters:** @@ -639,7 +639,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)* -*Defined in [Queries.ts:121](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L121)* +*Defined in [Queries.ts:121](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L121)* **Parameters:** @@ -656,7 +656,7 @@ ___ ▸ **referendumVotes**(index: * `ReferendumIndex` | `BN` | `number`*, addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`boolean`> -*Defined in [Combined.ts:176](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L176)* +*Defined in [Combined.ts:176](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L176)* **Parameters:** @@ -674,7 +674,7 @@ ___ ▸ **referendums**(): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> -*Defined in [Combined.ts:155](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L155)* +*Defined in [Combined.ts:155](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L155)* **Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> @@ -685,7 +685,7 @@ ___ ▸ **referendumsInfo**(referendumIds: *`Array`< `ReferendumIndex` | `BN` | `number`>*): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> -*Defined in [Combined.ts:127](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L127)* +*Defined in [Combined.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L127)* **Parameters:** @@ -702,7 +702,7 @@ ___ ▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:264](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L264)* +*Defined in [Combined.ts:264](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L264)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -713,7 +713,7 @@ ___ ▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:284](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L284)* +*Defined in [Combined.ts:284](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L284)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -724,7 +724,7 @@ ___ ▸ **sessionBrokenValue**(): `Observable`< `Moment` | `undefined`> -*Defined in [Combined.ts:299](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L299)* +*Defined in [Combined.ts:299](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L299)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -737,7 +737,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)* -*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L172)* +*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L172)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -750,7 +750,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)* -*Defined in [Queries.ts:176](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L176)* +*Defined in [Queries.ts:176](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L176)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -763,7 +763,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)* -*Defined in [Queries.ts:180](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L180)* +*Defined in [Queries.ts:180](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L180)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -776,7 +776,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)* -*Defined in [Queries.ts:184](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L184)* +*Defined in [Queries.ts:184](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L184)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -789,7 +789,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)* -*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L164)* +*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L164)* **Returns:** `Observable`< `Perbill` | `undefined`> @@ -802,7 +802,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)* -*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L168)* +*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L168)* **Returns:** `Observable`< `Balance` | `undefined`> @@ -813,7 +813,7 @@ ___ ▸ **sessionTimeExpected**(): `Observable`< `Moment` | `undefined`> -*Defined in [Combined.ts:318](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L318)* +*Defined in [Combined.ts:318](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L318)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -824,7 +824,7 @@ ___ ▸ **sessionTimeRemaining**(): `Observable`< `Moment` | `undefined`> -*Defined in [Combined.ts:333](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L333)* +*Defined in [Combined.ts:333](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L333)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -837,7 +837,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)* -*Defined in [Queries.ts:192](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L192)* +*Defined in [Queries.ts:192](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L192)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -850,7 +850,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)* -*Defined in [Queries.ts:188](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L188)* +*Defined in [Queries.ts:188](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L188)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -863,7 +863,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)* -*Defined in [Queries.ts:206](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L206)* +*Defined in [Queries.ts:206](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L206)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -876,7 +876,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)* -*Defined in [Queries.ts:234](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L234)* +*Defined in [Queries.ts:234](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L234)* **Parameters:** @@ -895,7 +895,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)* -*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L220)* +*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L220)* **Parameters:** @@ -914,7 +914,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[submitAndWatchExtrinsic](_calls_.apicalls.md#submitandwatchextrinsic)* -*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L51)* +*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L51)* **Parameters:** @@ -933,7 +933,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)* -*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L47)* +*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L47)* **Parameters:** @@ -952,7 +952,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeNewHead](_calls_.apicalls.md#subscribenewhead)* -*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L33)* +*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L33)* **Returns:** `Observable`< `Header` | `undefined`> @@ -965,7 +965,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)* -*Defined in [Queries.ts:238](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L238)* +*Defined in [Queries.ts:238](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L238)* **Returns:** `Observable`<`Array`<`EventRecord`>> @@ -978,7 +978,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)* -*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L39)* +*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L39)* **Returns:** `Observable`< `Text` | `undefined`> @@ -991,7 +991,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)* -*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L43)* +*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L43)* **Returns:** `Observable`< `Text` | `undefined`> @@ -1002,7 +1002,7 @@ ___ ▸ **validatingBalance**(address: * `AccountId` | `string`*): `Observable`<`RxBalance`> -*Defined in [Combined.ts:348](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L348)* +*Defined in [Combined.ts:348](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L348)* **Parameters:** @@ -1019,7 +1019,7 @@ ___ ▸ **validatingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`RxBalanceMap`> -*Defined in [Combined.ts:373](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L373)* +*Defined in [Combined.ts:373](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L373)* **Parameters:** @@ -1038,7 +1038,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)* -*Defined in [Queries.ts:252](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L252)* +*Defined in [Queries.ts:252](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L252)* **Returns:** `Observable`< `u32` | `undefined`> @@ -1049,7 +1049,7 @@ ___ ▸ **votingBalance**(address: * `AccountIndex` | `AccountId` | `string`*): `Observable`<`RxBalance`> -*Defined in [Combined.ts:387](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L387)* +*Defined in [Combined.ts:387](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L387)* **Parameters:** @@ -1066,7 +1066,7 @@ ___ ▸ **votingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`RxBalance`[]> -*Defined in [Combined.ts:427](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L427)* +*Defined in [Combined.ts:427](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L427)* **Parameters:** @@ -1083,7 +1083,7 @@ ___ ▸ **votingBalancesNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`any`> -*Defined in [Combined.ts:416](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L416)* +*Defined in [Combined.ts:416](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L416)* **Parameters:** diff --git a/docs/api-observable/classes/_index_.api.md b/docs/api-observable/classes/_index_.api.md index ea59144625..35dfec8759 100644 --- a/docs/api-observable/classes/_index_.api.md +++ b/docs/api-observable/classes/_index_.api.md @@ -16,7 +16,7 @@ *Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L34)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L34)* ___ @@ -49,7 +49,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)* -*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L42)* +*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L42)* ___ @@ -60,7 +60,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)* -*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L43)* +*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L43)* ___ @@ -74,7 +74,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L88)* +*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L88)* **Returns:** `Hash` @@ -90,7 +90,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[accountIdAndIndex](_combined_.apicombined.md#accountidandindex)* -*Defined in [Combined.ts:81](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L81)* +*Defined in [Combined.ts:81](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L81)* **Parameters:** @@ -109,7 +109,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[accountIdFromIndex](_combined_.apicombined.md#accountidfromindex)* -*Defined in [Combined.ts:55](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L55)* +*Defined in [Combined.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L55)* **Parameters:** @@ -128,7 +128,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[accountIndexFromId](_combined_.apicombined.md#accountindexfromid)* -*Defined in [Combined.ts:70](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L70)* +*Defined in [Combined.ts:70](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L70)* **Parameters:** @@ -147,7 +147,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[accountIndexes](_combined_.apicombined.md#accountindexes)* -*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L23)* +*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L23)* **Returns:** `Observable`<`object`> @@ -160,7 +160,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)* -*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L21)* +*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L21)* **Parameters:** @@ -179,7 +179,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)* -*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L25)* +*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L25)* **Parameters:** @@ -198,7 +198,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)* -*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L29)* +*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L29)* **Parameters:** @@ -217,7 +217,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)* -*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L13)* +*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L13)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -230,7 +230,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)* -*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L37)* +*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L37)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -243,7 +243,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)* -*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L33)* +*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L33)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -256,7 +256,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)* -*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L25)* +*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L25)* **Returns:** `Observable`< `Text` | `undefined`> @@ -269,7 +269,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)* -*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L41)* +*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L41)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -282,7 +282,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)* -*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L45)* +*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L45)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -295,7 +295,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendumVoters](_combined_.apicombined.md#democracyreferendumvoters)* -*Defined in [Combined.ts:139](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L139)* +*Defined in [Combined.ts:139](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L139)* **Parameters:** @@ -314,7 +314,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersBalancesOf](_combined_.apicombined.md#democracyvotersbalancesof)* -*Defined in [Combined.ts:184](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L184)* +*Defined in [Combined.ts:184](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L184)* **Parameters:** @@ -333,7 +333,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersVotesOf](_combined_.apicombined.md#democracyvotersvotesof)* -*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L200)* +*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L200)* **Parameters:** @@ -352,7 +352,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)* -*Defined in [Queries.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L135)* +*Defined in [Queries.ts:135](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L135)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -365,7 +365,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockLength](_combined_.apicombined.md#erablocklength)* -*Defined in [Combined.ts:211](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L211)* +*Defined in [Combined.ts:211](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L211)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -378,7 +378,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockProgress](_combined_.apicombined.md#erablockprogress)* -*Defined in [Combined.ts:226](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L226)* +*Defined in [Combined.ts:226](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L226)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -391,7 +391,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockRemaining](_combined_.apicombined.md#erablockremaining)* -*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L249)* +*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L249)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -404,7 +404,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)* -*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L160)* +*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L160)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -417,7 +417,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)* -*Defined in [Queries.ts:139](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L139)* +*Defined in [Queries.ts:139](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L139)* **Returns:** `Observable`<`RxFees`> @@ -430,7 +430,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)* -*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L49)* +*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L49)* **Parameters:** @@ -449,7 +449,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)* -*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L29)* +*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L29)* **Parameters:** @@ -468,7 +468,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* -*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L92)* +*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L92)* **Returns:** `Observable`<`boolean`> @@ -481,7 +481,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)* -*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L63)* +*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L63)* **Returns:** `Observable`< `AccountIndex` | `undefined`> @@ -494,7 +494,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)* -*Defined in [Queries.ts:67](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L67)* +*Defined in [Queries.ts:67](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L67)* **Parameters:** @@ -513,7 +513,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[publicProposalCount](_combined_.apicombined.md#publicproposalcount)* -*Defined in [Combined.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L117)* +*Defined in [Combined.ts:117](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L117)* **Returns:** `Observable`<`number`> @@ -526,7 +526,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)* -*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L80)* +*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L80)* **Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> @@ -539,7 +539,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* -*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L96)* +*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L96)* **Type parameters:** @@ -562,7 +562,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* -*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L109)* +*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L109)* **Type parameters:** @@ -585,7 +585,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* -*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L126)* +*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L126)* **Type parameters:** @@ -607,7 +607,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)* -*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L100)* +*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L100)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -620,7 +620,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)* -*Defined in [Queries.ts:104](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L104)* +*Defined in [Queries.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L104)* **Parameters:** @@ -639,7 +639,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)* -*Defined in [Queries.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L117)* +*Defined in [Queries.ts:117](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L117)* **Parameters:** @@ -659,7 +659,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)* -*Defined in [Queries.ts:121](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L121)* +*Defined in [Queries.ts:121](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L121)* **Parameters:** @@ -678,7 +678,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[referendumVotes](_combined_.apicombined.md#referendumvotes)* -*Defined in [Combined.ts:176](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L176)* +*Defined in [Combined.ts:176](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L176)* **Parameters:** @@ -698,7 +698,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[referendums](_combined_.apicombined.md#referendums)* -*Defined in [Combined.ts:155](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L155)* +*Defined in [Combined.ts:155](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L155)* **Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> @@ -711,7 +711,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[referendumsInfo](_combined_.apicombined.md#referendumsinfo)* -*Defined in [Combined.ts:127](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L127)* +*Defined in [Combined.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L127)* **Parameters:** @@ -730,7 +730,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockProgress](_combined_.apicombined.md#sessionblockprogress)* -*Defined in [Combined.ts:264](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L264)* +*Defined in [Combined.ts:264](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L264)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -743,7 +743,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockRemaining](_combined_.apicombined.md#sessionblockremaining)* -*Defined in [Combined.ts:284](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L284)* +*Defined in [Combined.ts:284](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L284)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -756,7 +756,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBrokenValue](_combined_.apicombined.md#sessionbrokenvalue)* -*Defined in [Combined.ts:299](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L299)* +*Defined in [Combined.ts:299](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L299)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -769,7 +769,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)* -*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L172)* +*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L172)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -782,7 +782,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)* -*Defined in [Queries.ts:176](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L176)* +*Defined in [Queries.ts:176](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L176)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -795,7 +795,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)* -*Defined in [Queries.ts:180](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L180)* +*Defined in [Queries.ts:180](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L180)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -808,7 +808,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)* -*Defined in [Queries.ts:184](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L184)* +*Defined in [Queries.ts:184](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L184)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -821,7 +821,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)* -*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L164)* +*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L164)* **Returns:** `Observable`< `Perbill` | `undefined`> @@ -834,7 +834,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)* -*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L168)* +*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L168)* **Returns:** `Observable`< `Balance` | `undefined`> @@ -847,7 +847,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeExpected](_combined_.apicombined.md#sessiontimeexpected)* -*Defined in [Combined.ts:318](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L318)* +*Defined in [Combined.ts:318](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L318)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -860,7 +860,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeRemaining](_combined_.apicombined.md#sessiontimeremaining)* -*Defined in [Combined.ts:333](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L333)* +*Defined in [Combined.ts:333](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L333)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -873,7 +873,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)* -*Defined in [Queries.ts:192](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L192)* +*Defined in [Queries.ts:192](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L192)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -886,7 +886,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)* -*Defined in [Queries.ts:188](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L188)* +*Defined in [Queries.ts:188](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L188)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -899,7 +899,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)* -*Defined in [Queries.ts:206](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L206)* +*Defined in [Queries.ts:206](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L206)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -912,7 +912,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)* -*Defined in [Queries.ts:234](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L234)* +*Defined in [Queries.ts:234](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L234)* **Parameters:** @@ -931,7 +931,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)* -*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L220)* +*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L220)* **Parameters:** @@ -950,7 +950,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[submitAndWatchExtrinsic](_calls_.apicalls.md#submitandwatchextrinsic)* -*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L51)* +*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L51)* **Parameters:** @@ -969,7 +969,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)* -*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L47)* +*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L47)* **Parameters:** @@ -988,7 +988,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeNewHead](_calls_.apicalls.md#subscribenewhead)* -*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L33)* +*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L33)* **Returns:** `Observable`< `Header` | `undefined`> @@ -1001,7 +1001,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)* -*Defined in [Queries.ts:238](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L238)* +*Defined in [Queries.ts:238](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L238)* **Returns:** `Observable`<`Array`<`EventRecord`>> @@ -1014,7 +1014,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)* -*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L39)* +*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L39)* **Returns:** `Observable`< `Text` | `undefined`> @@ -1027,7 +1027,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)* -*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Calls.ts#L43)* +*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Calls.ts#L43)* **Returns:** `Observable`< `Text` | `undefined`> @@ -1040,7 +1040,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalance](_combined_.apicombined.md#validatingbalance)* -*Defined in [Combined.ts:348](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L348)* +*Defined in [Combined.ts:348](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L348)* **Parameters:** @@ -1059,7 +1059,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalances](_combined_.apicombined.md#validatingbalances)* -*Defined in [Combined.ts:373](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L373)* +*Defined in [Combined.ts:373](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L373)* **Parameters:** @@ -1078,7 +1078,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)* -*Defined in [Queries.ts:252](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L252)* +*Defined in [Queries.ts:252](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L252)* **Returns:** `Observable`< `u32` | `undefined`> @@ -1091,7 +1091,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalance](_combined_.apicombined.md#votingbalance)* -*Defined in [Combined.ts:387](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L387)* +*Defined in [Combined.ts:387](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L387)* **Parameters:** @@ -1110,7 +1110,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalances](_combined_.apicombined.md#votingbalances)* -*Defined in [Combined.ts:427](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L427)* +*Defined in [Combined.ts:427](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L427)* **Parameters:** @@ -1129,7 +1129,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalancesNominatorsFor](_combined_.apicombined.md#votingbalancesnominatorsfor)* -*Defined in [Combined.ts:416](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Combined.ts#L416)* +*Defined in [Combined.ts:416](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Combined.ts#L416)* **Parameters:** diff --git a/docs/api-observable/classes/_queries_.apiqueries.md b/docs/api-observable/classes/_queries_.apiqueries.md index 319d223f2e..0a8418dae9 100644 --- a/docs/api-observable/classes/_queries_.apiqueries.md +++ b/docs/api-observable/classes/_queries_.apiqueries.md @@ -18,7 +18,7 @@ *Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L34)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)* -*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L34)* +*Defined in [Base.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L34)* ___ @@ -51,7 +51,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)* -*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L42)* +*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L42)* ___ @@ -62,7 +62,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)* -*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L43)* +*Defined in [Base.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L43)* ___ @@ -76,7 +76,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L88)* +*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L88)* **Returns:** `Hash` @@ -90,7 +90,7 @@ ___ ▸ **accountNonce**(address: * `AccountId` | `string`*): `Observable`< `Index` | `undefined`> -*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L21)* +*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L21)* **Parameters:** @@ -107,7 +107,7 @@ ___ ▸ **balanceFree**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`> -*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L25)* +*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L25)* **Parameters:** @@ -124,7 +124,7 @@ ___ ▸ **balanceReserved**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`> -*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L29)* +*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L29)* **Parameters:** @@ -141,7 +141,7 @@ ___ ▸ **blockNow**(): `Observable`< `Moment` | `undefined`> -*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L37)* +*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L37)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -152,7 +152,7 @@ ___ ▸ **blockPeriod**(): `Observable`< `Moment` | `undefined`> -*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L33)* +*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L33)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -163,7 +163,7 @@ ___ ▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L41)* +*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L41)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -174,7 +174,7 @@ ___ ▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` | `undefined`> -*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L45)* +*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L45)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -185,7 +185,7 @@ ___ ▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L135)* +*Defined in [Queries.ts:135](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L135)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -196,7 +196,7 @@ ___ ▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L160)* +*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L160)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -207,7 +207,7 @@ ___ ▸ **fees**(): `Observable`<`RxFees`> -*Defined in [Queries.ts:139](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L139)* +*Defined in [Queries.ts:139](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L139)* **Returns:** `Observable`<`RxFees`> @@ -218,7 +218,7 @@ ___ ▸ **getAccountEnumSet**(index: * `AccountIndex` | `BN` | `number`*): `Observable`< `Array`<`AccountId`> | `undefined`> -*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L49)* +*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L49)* **Parameters:** @@ -237,7 +237,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* -*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L92)* +*Defined in [Base.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L92)* **Returns:** `Observable`<`boolean`> @@ -248,7 +248,7 @@ ___ ▸ **nextAccountEnumSet**(): `Observable`< `AccountIndex` | `undefined`> -*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L63)* +*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L63)* **Returns:** `Observable`< `AccountIndex` | `undefined`> @@ -259,7 +259,7 @@ ___ ▸ **proposalDeposits**(proposalId: * `PropIndex` | `BN` | `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`> -*Defined in [Queries.ts:67](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L67)* +*Defined in [Queries.ts:67](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L67)* **Parameters:** @@ -276,7 +276,7 @@ ___ ▸ **publicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> -*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L80)* +*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L80)* **Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> @@ -289,7 +289,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* -*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L96)* +*Defined in [Base.ts:96](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L96)* **Type parameters:** @@ -312,7 +312,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* -*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L109)* +*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L109)* **Type parameters:** @@ -335,7 +335,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* -*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Base.ts#L126)* +*Defined in [Base.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Base.ts#L126)* **Type parameters:** @@ -355,7 +355,7 @@ ___ ▸ **referendumCount**(): `Observable`< `ReferendumIndex` | `undefined`> -*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L100)* +*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L100)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -366,7 +366,7 @@ ___ ▸ **referendumInfo**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`> -*Defined in [Queries.ts:104](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L104)* +*Defined in [Queries.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L104)* **Parameters:** @@ -383,7 +383,7 @@ ___ ▸ **referendumVote**(index: * `ReferendumIndex` | `BN` | `number`*, address: * `AccountId` | `string`*): `Observable`< `Bool` | `undefined`> -*Defined in [Queries.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L117)* +*Defined in [Queries.ts:117](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L117)* **Parameters:** @@ -401,7 +401,7 @@ ___ ▸ **referendumVoters**(index: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`AccountId`>> -*Defined in [Queries.ts:121](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L121)* +*Defined in [Queries.ts:121](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L121)* **Parameters:** @@ -418,7 +418,7 @@ ___ ▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L172)* +*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L172)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -429,7 +429,7 @@ ___ ▸ **sessionCurrentStart**(): `Observable`< `Moment` | `undefined`> -*Defined in [Queries.ts:176](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L176)* +*Defined in [Queries.ts:176](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L176)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -440,7 +440,7 @@ ___ ▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:180](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L180)* +*Defined in [Queries.ts:180](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L180)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -451,7 +451,7 @@ ___ ▸ **sessionLength**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:184](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L184)* +*Defined in [Queries.ts:184](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L184)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -462,7 +462,7 @@ ___ ▸ **sessionReward**(): `Observable`< `Perbill` | `undefined`> -*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L164)* +*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L164)* **Returns:** `Observable`< `Perbill` | `undefined`> @@ -473,7 +473,7 @@ ___ ▸ **sessionRewardCurrent**(): `Observable`< `Balance` | `undefined`> -*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L168)* +*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L168)* **Returns:** `Observable`< `Balance` | `undefined`> @@ -484,7 +484,7 @@ ___ ▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>> -*Defined in [Queries.ts:192](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L192)* +*Defined in [Queries.ts:192](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L192)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -495,7 +495,7 @@ ___ ▸ **sessionsPerEra**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:188](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L188)* +*Defined in [Queries.ts:188](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L188)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -506,7 +506,7 @@ ___ ▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>> -*Defined in [Queries.ts:206](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L206)* +*Defined in [Queries.ts:206](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L206)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -517,7 +517,7 @@ ___ ▸ **stakingNominating**(address: * `AccountId` | `string`*): `Observable`< `AccountId` | `undefined`> -*Defined in [Queries.ts:234](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L234)* +*Defined in [Queries.ts:234](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L234)* **Parameters:** @@ -534,7 +534,7 @@ ___ ▸ **stakingNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`Array`<`AccountId`>> -*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L220)* +*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L220)* **Parameters:** @@ -551,7 +551,7 @@ ___ ▸ **systemEvents**(): `Observable`<`Array`<`EventRecord`>> -*Defined in [Queries.ts:238](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L238)* +*Defined in [Queries.ts:238](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L238)* **Returns:** `Observable`<`Array`<`EventRecord`>> @@ -562,7 +562,7 @@ ___ ▸ **validatorCount**(): `Observable`< `u32` | `undefined`> -*Defined in [Queries.ts:252](https://github.com/polkadot-js/api/blob/de284fb/packages/api-observable/src/Queries.ts#L252)* +*Defined in [Queries.ts:252](https://github.com/polkadot-js/api/blob/73710b7/packages/api-observable/src/Queries.ts#L252)* **Returns:** `Observable`< `u32` | `undefined`> diff --git a/docs/api/classes/_base_.apibase.md b/docs/api/classes/_base_.apibase.md index 56956b1d67..b8321b8a3b 100644 --- a/docs/api/classes/_base_.apibase.md +++ b/docs/api/classes/_base_.apibase.md @@ -24,7 +24,7 @@ ⊕ **new ApiBase**(wsProvider?: *`WsProvider`*): [ApiBase](_base_.apibase.md) -*Defined in [Base.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L39)* +*Defined in [Base.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L39)* *__description__*: Create an instance of the class @@ -58,7 +58,7 @@ ___ getgenesisHash(): `Hash` -*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L70)* +*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L70)* *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. @@ -71,7 +71,7 @@ ___ getquery(): `S` -*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L108)* +*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L108)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -94,7 +94,7 @@ ___ getrpc(): `R` -*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L128)* +*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L128)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -117,7 +117,7 @@ ___ getruntimeMetadata(): `RuntimeMetadata` -*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L79)* +*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L79)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -130,7 +130,7 @@ ___ getruntimeVersion(): `RuntimeVersion` -*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L88)* +*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L88)* *__description__*: Contains the version information for the current runtime. @@ -143,7 +143,7 @@ ___ gettx(): `E` -*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L147)* +*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L147)* *__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. @@ -170,7 +170,7 @@ ___ ▸ **on**(type: *`ApiInterface$Events`*, handler: *`function`*): `void` -*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L172)* +*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L172)* *__description__*: Attach an eventemitter handler to listen to a specific event diff --git a/docs/api/classes/_promise_combinator_.combinator.md b/docs/api/classes/_promise_combinator_.combinator.md index aef1811fff..6ae2473acc 100644 --- a/docs/api/classes/_promise_combinator_.combinator.md +++ b/docs/api/classes/_promise_combinator_.combinator.md @@ -12,7 +12,7 @@ ⊕ **new Combinator**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction)>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md) -*Defined in [promise/Combinator.ts:14](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/promise/Combinator.ts#L14)* +*Defined in [promise/Combinator.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/promise/Combinator.ts#L14)* **Parameters:** diff --git a/docs/api/classes/_promise_index_.apipromise.html b/docs/api/classes/_promise_index_.apipromise.html index bc2543bb19..efc5246232 100644 --- a/docs/api/classes/_promise_index_.apipromise.html +++ b/docs/api/classes/_promise_index_.apipromise.html @@ -469,7 +469,7 @@

constructor

⊕ new ApiPromise(wsProvider?: WsProvider): ApiPromise

Overrides ApiBase.constructor

-

Defined in promise/index.ts:128

+

Defined in promise/index.ts:128

description: Creates an instance of the ApiPromise class

example:

import Api from '@polkadot/api/promise';
@@ -504,14 +504,14 @@
 

genesisHash

getgenesisHash(): Hash

Inherited from ApiBase.genesisHash

-

Defined in Base.ts:70

+

Defined in Base.ts:70

description: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.

Returns: Hash


isReady

getisReady(): Promise<ApiPromise>

-

Defined in promise/index.ts:161

+

Defined in promise/index.ts:161

description: Promise that returns the first time we are connected and loaded

Returns: Promise<ApiPromise>


@@ -519,7 +519,7 @@

query

getquery(): QueryableStorage

Inherited from ApiBase.query

-

Defined in Base.ts:108

+

Defined in Base.ts:108

description: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.

All calls inside the namespace, is denoted by section.method and may take an optional query parameter. As an example, api.query.timestamp.now() (current block timestamp) does not take parameters, while api.query.system.accountNonce(<accountId>) (retrieving the associated nonce for an account), takes the AccountId as a parameter.

example:

@@ -533,7 +533,7 @@

rpc

getrpc(): Rpc

Inherited from ApiBase.rpc

-

Defined in Base.ts:128

+

Defined in Base.ts:128

description: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic api.query and api.tx sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.

RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.

example:

@@ -547,7 +547,7 @@

runtimeMetadata

getruntimeMetadata(): RuntimeMetadata

Inherited from ApiBase.runtimeMetadata

-

Defined in Base.ts:79

+

Defined in Base.ts:79

description: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.

Returns: RuntimeMetadata


@@ -555,7 +555,7 @@

runtimeVersion

getruntimeVersion(): RuntimeVersion

Inherited from ApiBase.runtimeVersion

-

Defined in Base.ts:88

+

Defined in Base.ts:88

description: Contains the version information for the current runtime.

Returns: RuntimeVersion


@@ -563,7 +563,7 @@

tx

gettx(): SubmittableExtrinsics

Inherited from ApiBase.tx

-

Defined in Base.ts:147

+

Defined in Base.ts:147

description: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.

example:

api.tx.balances
@@ -579,7 +579,7 @@
 

combineLatest

▸ combineLatest(fns: Array<CombinatorFunction>, callback: CombinatorCallback): Combinator

-

Defined in promise/index.ts:189

+

Defined in promise/index.ts:189

description: Creates a combinator that can be used to combine the latest results from multiple subscriptions

example:

const address = '5DTestUPts3kjeXSTMyerHihn1uwMfLj8vU8sqF7qYrFacT7';
@@ -621,7 +621,7 @@
 

on

▸ on(type: ApiInterface$Events, handler: function): void

Inherited from ApiBase.on

-

Defined in Base.ts:172

+

Defined in Base.ts:172

description: Attach an eventemitter handler to listen to a specific event

example:

api.on('disconnected', () => {
@@ -659,7 +659,7 @@
 

<Static> create

▸ create(wsProvider?: WsProvider): Promise<ApiPromise>

-

Defined in promise/index.ts:126

+

Defined in promise/index.ts:126

description: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.

example:

import Api from '@polkadot/api/promise';
@@ -732,7 +732,7 @@
     
 
diff --git a/docs/api/classes/_promise_index_.apipromise.md b/docs/api/classes/_promise_index_.apipromise.md index 45bb7d1679..f90501c3da 100644 --- a/docs/api/classes/_promise_index_.apipromise.md +++ b/docs/api/classes/_promise_index_.apipromise.md @@ -106,7 +106,7 @@ ApiPromise.create().then((api) => { *Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [promise/index.ts:128](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/promise/index.ts#L128)* +*Defined in [promise/index.ts:128](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/promise/index.ts#L128)* *__description__*: Creates an instance of the ApiPromise class @@ -142,7 +142,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L70)* +*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L70)* *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. @@ -155,7 +155,7 @@ ___ getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)> -*Defined in [promise/index.ts:161](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/promise/index.ts#L161)* +*Defined in [promise/index.ts:161](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/promise/index.ts#L161)* *__description__*: Promise that returns the first time we are connected and loaded @@ -170,7 +170,7 @@ getquery(): `QueryableStorage` *Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* -*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L108)* +*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L108)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -195,7 +195,7 @@ getrpc(): `Rpc` *Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* -*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L128)* +*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L128)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -220,7 +220,7 @@ getruntimeMetadata(): `RuntimeMetadata` *Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* -*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L79)* +*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L79)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -235,7 +235,7 @@ getruntimeVersion(): `RuntimeVersion` *Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* -*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L88)* +*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L88)* *__description__*: Contains the version information for the current runtime. @@ -250,7 +250,7 @@ gettx(): `SubmittableExtrinsics` *Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* -*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L147)* +*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L147)* *__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. @@ -277,7 +277,7 @@ ___ ▸ **combineLatest**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction)>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md) -*Defined in [promise/index.ts:189](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/promise/index.ts#L189)* +*Defined in [promise/index.ts:189](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/promise/index.ts#L189)* *__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions @@ -314,7 +314,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* -*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L172)* +*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L172)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -346,7 +346,7 @@ ___ ▸ **create**(wsProvider?: *`WsProvider`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)> -*Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/promise/index.ts#L126)* +*Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/promise/index.ts#L126)* *__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance. diff --git a/docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md b/docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md index 347c4b3ec4..8f1a7bb9c4 100644 --- a/docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md +++ b/docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md @@ -25,7 +25,7 @@ *Overrides Extrinsic.__constructor* -*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/promise/SubmittableExtrinsic.ts#L12)* +*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/promise/SubmittableExtrinsic.ts#L12)* **Parameters:** @@ -59,7 +59,7 @@ ___ *Inherited from Struct.raw* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -84,7 +84,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -97,7 +97,7 @@ getargs(): `Array`<`Base`> *Inherited from Extrinsic.args* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:73](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L73)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L70)* **Returns:** `Array`<`Base`> @@ -110,7 +110,7 @@ getcallIndex(): `Uint8Array` *Inherited from Extrinsic.callIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L78)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:75](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L75)* **Returns:** `Uint8Array` @@ -123,7 +123,7 @@ getdata(): `Uint8Array` *Inherited from Extrinsic.data* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:82](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L82)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L79)* **Returns:** `Uint8Array` @@ -138,7 +138,7 @@ getencodedLength(): `number` *Overrides Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L113)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L110)* **Returns:** `number` @@ -151,7 +151,7 @@ gethash(): `Hash` *Inherited from Extrinsic.hash* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:87](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L87)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:84](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L84)* **Returns:** `Hash` @@ -164,7 +164,7 @@ getisSigned(): `boolean` *Inherited from Extrinsic.isSigned* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:93](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L93)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L90)* **Returns:** `boolean` @@ -177,7 +177,7 @@ getlength(): `number` *Inherited from Extrinsic.length* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L97)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:94](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L94)* **Returns:** `number` @@ -190,7 +190,7 @@ getmeta(): `FunctionMetadata` *Inherited from Extrinsic.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L101)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L98)* **Returns:** `FunctionMetadata` @@ -203,7 +203,7 @@ getmethod(): `Method` *Inherited from Extrinsic.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:105](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L105)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:102](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L102)* **Returns:** `Method` @@ -216,7 +216,7 @@ getsignature(): `ExtrinsicSignature` *Inherited from Extrinsic.signature* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:109](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L109)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L106)* **Returns:** `ExtrinsicSignature` @@ -333,7 +333,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -384,7 +384,7 @@ ___ ▸ **send**(statusCb?: * `undefined` | `function`*): `Promise`<`Hash`> -*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/promise/SubmittableExtrinsic.ts#L20)* +*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/promise/SubmittableExtrinsic.ts#L20)* **Parameters:** @@ -423,7 +423,7 @@ ___ *Overrides Extrinsic.sign* -*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/promise/SubmittableExtrinsic.ts#L28)* +*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/promise/SubmittableExtrinsic.ts#L28)* **Parameters:** @@ -444,7 +444,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<`Base`> @@ -459,7 +459,7 @@ ___ *Overrides Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L136)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L133)* **Returns:** `string` @@ -474,7 +474,7 @@ ___ *Overrides Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L140)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L137)* **Returns:** `any` @@ -487,7 +487,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -502,7 +502,7 @@ ___ *Overrides Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:125](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L125)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L122)* **Parameters:** @@ -536,7 +536,7 @@ ___ *Inherited from Extrinsic.decodeExtrinsic* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L43)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:42](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L42)* **Parameters:** @@ -555,7 +555,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/api/classes/_rx_index_.apirx.html b/docs/api/classes/_rx_index_.apirx.html index 45c5130017..2baa355a6d 100644 --- a/docs/api/classes/_rx_index_.apirx.html +++ b/docs/api/classes/_rx_index_.apirx.html @@ -480,7 +480,7 @@

constructor

⊕ new ApiRx(wsProvider?: WsProvider): ApiRx

Overrides ApiBase.constructor

-

Defined in rx/index.ts:143

+

Defined in rx/index.ts:143

description: Create an instance of the ApiRx class

example:

import Api from '@polkadot/api/rx';
@@ -515,21 +515,21 @@
 

genesisHash

getgenesisHash(): Hash

Inherited from ApiBase.genesisHash

-

Defined in Base.ts:70

+

Defined in Base.ts:70

description: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.

Returns: Hash


isConnected

getisConnected(): Observable<boolean>

-

Defined in rx/index.ts:179

+

Defined in rx/index.ts:179

description: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.

Returns: Observable<boolean>


isReady

getisReady(): Observable<ApiRx>

-

Defined in rx/index.ts:186

+

Defined in rx/index.ts:186

description: Observable that returns the first time we are connected and loaded

Returns: Observable<ApiRx>


@@ -537,7 +537,7 @@

query

getquery(): QueryableStorage

Inherited from ApiBase.query

-

Defined in Base.ts:108

+

Defined in Base.ts:108

description: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.

All calls inside the namespace, is denoted by section.method and may take an optional query parameter. As an example, api.query.timestamp.now() (current block timestamp) does not take parameters, while api.query.system.accountNonce(<accountId>) (retrieving the associated nonce for an account), takes the AccountId as a parameter.

example:

@@ -551,7 +551,7 @@

rpc

getrpc(): RpcRx

Inherited from ApiBase.rpc

-

Defined in Base.ts:128

+

Defined in Base.ts:128

description: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic api.query and api.tx sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.

RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.

example:

@@ -565,7 +565,7 @@

runtimeMetadata

getruntimeMetadata(): RuntimeMetadata

Inherited from ApiBase.runtimeMetadata

-

Defined in Base.ts:79

+

Defined in Base.ts:79

description: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.

Returns: RuntimeMetadata


@@ -573,7 +573,7 @@

runtimeVersion

getruntimeVersion(): RuntimeVersion

Inherited from ApiBase.runtimeVersion

-

Defined in Base.ts:88

+

Defined in Base.ts:88

description: Contains the version information for the current runtime.

Returns: RuntimeVersion


@@ -581,7 +581,7 @@

tx

gettx(): SubmittableExtrinsics

Inherited from ApiBase.tx

-

Defined in Base.ts:147

+

Defined in Base.ts:147

description: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.

example:

api.tx.balances
@@ -598,7 +598,7 @@
 

on

▸ on(type: ApiInterface$Events, handler: function): void

Inherited from ApiBase.on

-

Defined in Base.ts:172

+

Defined in Base.ts:172

description: Attach an eventemitter handler to listen to a specific event

example:

api.on('disconnected', () => {
@@ -636,7 +636,7 @@
 

<Static> create

▸ create(wsProvider?: WsProvider): Observable<ApiRx>

-

Defined in rx/index.ts:141

+

Defined in rx/index.ts:141

description: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.

example:

import Api from '@polkadot/api/rx';
@@ -709,7 +709,7 @@
     
 
diff --git a/docs/api/classes/_rx_index_.apirx.md b/docs/api/classes/_rx_index_.apirx.md index ecf1a3b4a3..cde829f474 100644 --- a/docs/api/classes/_rx_index_.apirx.md +++ b/docs/api/classes/_rx_index_.apirx.md @@ -117,7 +117,7 @@ api.query.system *Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/rx/index.ts#L143)* +*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/rx/index.ts#L143)* *__description__*: Create an instance of the ApiRx class @@ -153,7 +153,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L70)* +*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L70)* *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. @@ -166,7 +166,7 @@ ___ getisConnected(): `Observable`<`boolean`> -*Defined in [rx/index.ts:179](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/rx/index.ts#L179)* +*Defined in [rx/index.ts:179](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/rx/index.ts#L179)* *__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity. @@ -179,7 +179,7 @@ ___ getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)> -*Defined in [rx/index.ts:186](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/rx/index.ts#L186)* +*Defined in [rx/index.ts:186](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/rx/index.ts#L186)* *__description__*: Observable that returns the first time we are connected and loaded @@ -194,7 +194,7 @@ getquery(): `QueryableStorage` *Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* -*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L108)* +*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L108)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -219,7 +219,7 @@ getrpc(): `RpcRx` *Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* -*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L128)* +*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L128)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -244,7 +244,7 @@ getruntimeMetadata(): `RuntimeMetadata` *Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* -*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L79)* +*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L79)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -259,7 +259,7 @@ getruntimeVersion(): `RuntimeVersion` *Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* -*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L88)* +*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L88)* *__description__*: Contains the version information for the current runtime. @@ -274,7 +274,7 @@ gettx(): `SubmittableExtrinsics` *Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* -*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L147)* +*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L147)* *__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. @@ -303,7 +303,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* -*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/Base.ts#L172)* +*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/Base.ts#L172)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -335,7 +335,7 @@ ___ ▸ **create**(wsProvider?: *`WsProvider`*): `Observable`<[ApiRx](_rx_index_.apirx.md)> -*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/rx/index.ts#L141)* +*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/rx/index.ts#L141)* *__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance. diff --git a/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md b/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md index 4f147a781b..b38fde3c06 100644 --- a/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md +++ b/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md @@ -25,7 +25,7 @@ *Overrides Extrinsic.__constructor* -*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/rx/SubmittableExtrinsic.ts#L13)* +*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/rx/SubmittableExtrinsic.ts#L13)* **Parameters:** @@ -59,7 +59,7 @@ ___ *Inherited from Struct.raw* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -84,7 +84,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -97,7 +97,7 @@ getargs(): `Array`<`Base`> *Inherited from Extrinsic.args* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:73](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L73)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L70)* **Returns:** `Array`<`Base`> @@ -110,7 +110,7 @@ getcallIndex(): `Uint8Array` *Inherited from Extrinsic.callIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L78)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:75](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L75)* **Returns:** `Uint8Array` @@ -123,7 +123,7 @@ getdata(): `Uint8Array` *Inherited from Extrinsic.data* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:82](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L82)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L79)* **Returns:** `Uint8Array` @@ -138,7 +138,7 @@ getencodedLength(): `number` *Overrides Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L113)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L110)* **Returns:** `number` @@ -151,7 +151,7 @@ gethash(): `Hash` *Inherited from Extrinsic.hash* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:87](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L87)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:84](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L84)* **Returns:** `Hash` @@ -164,7 +164,7 @@ getisSigned(): `boolean` *Inherited from Extrinsic.isSigned* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:93](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L93)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L90)* **Returns:** `boolean` @@ -177,7 +177,7 @@ getlength(): `number` *Inherited from Extrinsic.length* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L97)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:94](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L94)* **Returns:** `number` @@ -190,7 +190,7 @@ getmeta(): `FunctionMetadata` *Inherited from Extrinsic.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L101)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L98)* **Returns:** `FunctionMetadata` @@ -203,7 +203,7 @@ getmethod(): `Method` *Inherited from Extrinsic.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:105](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L105)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:102](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L102)* **Returns:** `Method` @@ -216,7 +216,7 @@ getsignature(): `ExtrinsicSignature` *Inherited from Extrinsic.signature* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:109](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L109)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L106)* **Returns:** `ExtrinsicSignature` @@ -333,7 +333,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -384,7 +384,7 @@ ___ ▸ **send**(): `Observable`<`ExtrinsicStatus`> -*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/rx/SubmittableExtrinsic.ts#L21)* +*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/rx/SubmittableExtrinsic.ts#L21)* **Returns:** `Observable`<`ExtrinsicStatus`> @@ -417,7 +417,7 @@ ___ *Overrides Extrinsic.sign* -*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/rx/SubmittableExtrinsic.ts#L25)* +*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/rx/SubmittableExtrinsic.ts#L25)* **Parameters:** @@ -438,7 +438,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<`Base`> @@ -453,7 +453,7 @@ ___ *Overrides Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L136)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L133)* **Returns:** `string` @@ -468,7 +468,7 @@ ___ *Overrides Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L140)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L137)* **Returns:** `any` @@ -481,7 +481,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -496,7 +496,7 @@ ___ *Overrides Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:125](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L125)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L122)* **Parameters:** @@ -530,7 +530,7 @@ ___ *Inherited from Extrinsic.decodeExtrinsic* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L43)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:42](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L42)* **Parameters:** @@ -549,7 +549,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/api/index.html b/docs/api/index.html index 5a41f7d43a..16aae47464 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -495,7 +495,7 @@
diff --git a/docs/api/modules/_promise_combinator_.md b/docs/api/modules/_promise_combinator_.md index e089e9d15a..3036d48868 100644 --- a/docs/api/modules/_promise_combinator_.md +++ b/docs/api/modules/_promise_combinator_.md @@ -21,7 +21,7 @@ **Ƭ CombinatorCallback**: *`function`* -*Defined in [promise/Combinator.ts:7](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/promise/Combinator.ts#L7)* +*Defined in [promise/Combinator.ts:7](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/promise/Combinator.ts#L7)* #### Type declaration ▸(value: *`Array`<`any`>*): `any` @@ -41,7 +41,7 @@ ___ **Ƭ CombinatorFunction**: *`function`* -*Defined in [promise/Combinator.ts:8](https://github.com/polkadot-js/api/blob/de284fb/packages/api/src/promise/Combinator.ts#L8)* +*Defined in [promise/Combinator.ts:8](https://github.com/polkadot-js/api/blob/73710b7/packages/api/src/promise/Combinator.ts#L8)* #### Type declaration ▸(cb: *`function`*): `any` diff --git a/docs/examples/promise/01_simple_connect/index.html b/docs/examples/promise/01_simple_connect/index.html index a4153bc645..56985272a2 100644 --- a/docs/examples/promise/01_simple_connect/index.html +++ b/docs/examples/promise/01_simple_connect/index.html @@ -461,7 +461,7 @@
diff --git a/docs/examples/promise/02_listen_to_blocks/index.html b/docs/examples/promise/02_listen_to_blocks/index.html index 0c0b1621f9..4927c3852f 100644 --- a/docs/examples/promise/02_listen_to_blocks/index.html +++ b/docs/examples/promise/02_listen_to_blocks/index.html @@ -463,7 +463,7 @@
diff --git a/docs/examples/promise/03_listen_to_balance_change/index.html b/docs/examples/promise/03_listen_to_balance_change/index.html index 7aa9742044..254a654080 100644 --- a/docs/examples/promise/03_listen_to_balance_change/index.html +++ b/docs/examples/promise/03_listen_to_balance_change/index.html @@ -474,7 +474,7 @@
diff --git a/docs/examples/promise/05_read_storage/index.html b/docs/examples/promise/05_read_storage/index.html index f45ce12cc3..ca6263378f 100644 --- a/docs/examples/promise/05_read_storage/index.html +++ b/docs/examples/promise/05_read_storage/index.html @@ -473,7 +473,7 @@
diff --git a/docs/examples/promise/07_transfer_dots/index.html b/docs/examples/promise/07_transfer_dots/index.html index dd9cadc78d..4a11b6cf63 100644 --- a/docs/examples/promise/07_transfer_dots/index.html +++ b/docs/examples/promise/07_transfer_dots/index.html @@ -469,7 +469,7 @@
diff --git a/docs/examples/promise/index.html b/docs/examples/promise/index.html index 79d52b7ae5..26714b270d 100644 --- a/docs/examples/promise/index.html +++ b/docs/examples/promise/index.html @@ -451,7 +451,7 @@
diff --git a/docs/index.html b/docs/index.html index 826c8b9b1d..6dbafc52cc 100644 --- a/docs/index.html +++ b/docs/index.html @@ -475,7 +475,7 @@
diff --git a/docs/rpc-core/classes/_index_.rpc.md b/docs/rpc-core/classes/_index_.rpc.md index badcd34560..722165557c 100644 --- a/docs/rpc-core/classes/_index_.rpc.md +++ b/docs/rpc-core/classes/_index_.rpc.md @@ -38,7 +38,7 @@ const api = new Api(provider); ⊕ **new Rpc**(provider?: *`ProviderInterface`*): [Rpc](_index_.rpc.md) -*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-core/src/index.ts#L43)* +*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-core/src/index.ts#L43)* *__constructor__*: Default constructor for the Api Object @@ -60,7 +60,7 @@ ___ **● _provider**: *`ProviderInterface`* -*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-core/src/index.ts#L39)* +*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-core/src/index.ts#L39)* ___ @@ -69,7 +69,7 @@ ___ **● author**: *`RpcInterface$Section`* -*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-core/src/index.ts#L40)* +*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-core/src/index.ts#L40)* ___ @@ -78,7 +78,7 @@ ___ **● chain**: *`RpcInterface$Section`* -*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-core/src/index.ts#L41)* +*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-core/src/index.ts#L41)* ___ @@ -87,7 +87,7 @@ ___ **● state**: *`RpcInterface$Section`* -*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-core/src/index.ts#L42)* +*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-core/src/index.ts#L42)* ___ @@ -96,7 +96,7 @@ ___ **● system**: *`RpcInterface$Section`* -*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-core/src/index.ts#L43)* +*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-core/src/index.ts#L43)* ___ @@ -108,7 +108,7 @@ ___ ▸ **signature**(__namedParameters: *`object`*): `string` -*Defined in [index.ts:76](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-core/src/index.ts#L76)* +*Defined in [index.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-core/src/index.ts#L76)* *__name__*: signature diff --git a/docs/rpc-provider/classes/_coder_index_.rpccoder.md b/docs/rpc-provider/classes/_coder_index_.rpccoder.md index 6126cb2402..e77147de76 100644 --- a/docs/rpc-provider/classes/_coder_index_.rpccoder.md +++ b/docs/rpc-provider/classes/_coder_index_.rpccoder.md @@ -12,7 +12,7 @@ ▸ **decodeResponse**(response: *`JsonRpcResponse`*): `any` -*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/coder/index.ts#L12)* +*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/coder/index.ts#L12)* **Parameters:** @@ -29,7 +29,7 @@ ___ ▸ **encodeJson**(method: *`string`*, params: * `any` | `Array`<`any`>*): `string` -*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/coder/index.ts#L33)* +*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/coder/index.ts#L33)* **Parameters:** @@ -47,7 +47,7 @@ ___ ▸ **encodeObject**(method: *`string`*, params: * `any` | `Array`<`any`>*): `JsonRpcRequest` -*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/coder/index.ts#L39)* +*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/coder/index.ts#L39)* **Parameters:** @@ -65,7 +65,7 @@ ___ ▸ **getId**(): `number` -*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/coder/index.ts#L48)* +*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/coder/index.ts#L48)* **Returns:** `number` diff --git a/docs/rpc-provider/classes/_http_index_.httpprovider.html b/docs/rpc-provider/classes/_http_index_.httpprovider.html index 0bc468d9fd..a45e7c3ab4 100644 --- a/docs/rpc-provider/classes/_http_index_.httpprovider.html +++ b/docs/rpc-provider/classes/_http_index_.httpprovider.html @@ -414,7 +414,7 @@

constructor

⊕ new HttpProvider(endpoint?: string): HttpProvider

-

Defined in http/index.ts:40

+

Defined in http/index.ts:40

Parameters:

@@ -440,7 +440,7 @@

isConnected

▸ isConnected(): boolean

-

Defined in http/index.ts:56

+

Defined in http/index.ts:56

summary: Whether the node is connected or not.

Returns: boolean true if connected

@@ -448,7 +448,7 @@ true if connected

on

▸ on(type: ProviderInterface$Emitted, sub: ProviderInterface$EmitCb): void

-

Defined in http/index.ts:64

+

Defined in http/index.ts:64

summary: Events are not supported with the HttpProvider, see WsProvider.

description: HTTP Provider does not have 'on' emitters. WebSockets should be used instead.

Parameters:

@@ -475,7 +475,7 @@ true if connected

send

▸ send(method: string, params: Array<any>): Promise<any>

-

Defined in http/index.ts:71

+

Defined in http/index.ts:71

summary: Send HTTP POST Request with Body to configured HTTP Endpoint.

Parameters:

@@ -501,7 +501,7 @@ true if connected

subscribe

▸ subscribe(types: string, method: string, params: Array<any>, cb: ProviderInterface$Callback): Promise<number>

-

Defined in http/index.ts:93

+

Defined in http/index.ts:93

summary: Subscriptions are not supported with the HttpProvider, see WsProvider.

Parameters:

@@ -535,7 +535,7 @@ true if connected

unsubscribe

▸ unsubscribe(type: string, method: string, id: number): Promise<boolean>

-

Defined in http/index.ts:102

+

Defined in http/index.ts:102

summary: Subscriptions are not supported with the HttpProvider, see WsProvider.

Parameters:

@@ -605,7 +605,7 @@ true if connected

diff --git a/docs/rpc-provider/classes/_http_index_.httpprovider.md b/docs/rpc-provider/classes/_http_index_.httpprovider.md index b5cf789629..04b2882894 100644 --- a/docs/rpc-provider/classes/_http_index_.httpprovider.md +++ b/docs/rpc-provider/classes/_http_index_.httpprovider.md @@ -34,7 +34,7 @@ const api = new Api(provider); ⊕ **new HttpProvider**(endpoint?: *`string`*): [HttpProvider](_http_index_.httpprovider.md) -*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/http/index.ts#L40)* +*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/http/index.ts#L40)* **Parameters:** @@ -54,7 +54,7 @@ ___ ▸ **isConnected**(): `boolean` -*Defined in [http/index.ts:56](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/http/index.ts#L56)* +*Defined in [http/index.ts:56](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/http/index.ts#L56)* *__summary__*: Whether the node is connected or not. @@ -68,7 +68,7 @@ ___ ▸ **on**(type: *`ProviderInterface$Emitted`*, sub: *`ProviderInterface$EmitCb`*): `void` -*Defined in [http/index.ts:64](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/http/index.ts#L64)* +*Defined in [http/index.ts:64](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/http/index.ts#L64)* *__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). @@ -90,7 +90,7 @@ ___ ▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> -*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/http/index.ts#L71)* +*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/http/index.ts#L71)* *__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint. @@ -110,7 +110,7 @@ ___ ▸ **subscribe**(types: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *`ProviderInterface$Callback`*): `Promise`<`number`> -*Defined in [http/index.ts:93](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/http/index.ts#L93)* +*Defined in [http/index.ts:93](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/http/index.ts#L93)* *__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). @@ -132,7 +132,7 @@ ___ ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [http/index.ts:102](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/http/index.ts#L102)* +*Defined in [http/index.ts:102](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/http/index.ts#L102)* *__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). diff --git a/docs/rpc-provider/classes/_mock_index_.mock.md b/docs/rpc-provider/classes/_mock_index_.mock.md index 8e17f38490..83c30c1b21 100644 --- a/docs/rpc-provider/classes/_mock_index_.mock.md +++ b/docs/rpc-provider/classes/_mock_index_.mock.md @@ -19,7 +19,7 @@ A mock provider mainly used for testing. ⊕ **new Mock**(): [Mock](_mock_index_.mock.md) -*Defined in [mock/index.ts:64](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/mock/index.ts#L64)* +*Defined in [mock/index.ts:64](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/mock/index.ts#L64)* **Returns:** [Mock](_mock_index_.mock.md) @@ -33,7 +33,7 @@ ___ **● isUpdating**: *`boolean`* = true -*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/mock/index.ts#L42)* +*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/mock/index.ts#L42)* ___ @@ -49,7 +49,7 @@ ___ return subs; }, ({} as MockState$Subscriptions)) -*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/mock/index.ts#L53)* +*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/mock/index.ts#L53)* ___ @@ -61,7 +61,7 @@ ___ ▸ **isConnected**(): `boolean` -*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/mock/index.ts#L70)* +*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/mock/index.ts#L70)* **Returns:** `boolean` @@ -72,7 +72,7 @@ ___ ▸ **on**(type: *`ProviderInterface$Emitted`*, sub: *`ProviderInterface$EmitCb`*): `void` -*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/mock/index.ts#L74)* +*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/mock/index.ts#L74)* **Parameters:** @@ -90,7 +90,7 @@ ___ ▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> -*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/mock/index.ts#L78)* +*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/mock/index.ts#L78)* **Parameters:** @@ -108,7 +108,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, ...params: *`Array`<`any`>*): `Promise`<`number`> -*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/mock/index.ts#L86)* +*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/mock/index.ts#L86)* **Parameters:** @@ -127,7 +127,7 @@ ___ ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [mock/index.ts:106](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/mock/index.ts#L106)* +*Defined in [mock/index.ts:106](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/mock/index.ts#L106)* **Parameters:** diff --git a/docs/rpc-provider/classes/_ws_index_.wsprovider.html b/docs/rpc-provider/classes/_ws_index_.wsprovider.html index 51ffa71e02..34ecf0846c 100644 --- a/docs/rpc-provider/classes/_ws_index_.wsprovider.html +++ b/docs/rpc-provider/classes/_ws_index_.wsprovider.html @@ -414,7 +414,7 @@

constructor

⊕ new WsProvider(endpoint?: string, autoConnect?: boolean): WsProvider

-

Defined in ws/index.ts:75

+

Defined in ws/index.ts:75

Parameters:

@@ -446,7 +446,7 @@

connect

▸ connect(): void

-

Defined in ws/index.ts:103

+

Defined in ws/index.ts:103

summary: Manually connect

description: The WsProvider connects automatically by default, however if you decided otherwise, you may connect manually using this method.

Returns: void

@@ -454,7 +454,7 @@

isConnected

▸ isConnected(): boolean

-

Defined in ws/index.ts:120

+

Defined in ws/index.ts:120

summary: Whether the node is connected or not.

Returns: boolean true if connected

@@ -462,7 +462,7 @@ true if connected

on

▸ on(type: ProviderInterface$Emitted, sub: ProviderInterface$EmitCb): void

-

Defined in ws/index.ts:129

+

Defined in ws/index.ts:129

summary: Listens on events after having subscribed using the subscribe function.

Parameters:

@@ -491,7 +491,7 @@ true if connected

send

▸ send(method: string, params: Array<any>, subscription?: SubscriptionHandler): Promise<any>

-

Defined in ws/index.ts:139

+

Defined in ws/index.ts:139

summary: Send JSON data using WebSockets to configured HTTP Endpoint or queue.

Parameters:

@@ -525,7 +525,7 @@ true if connected

subscribe

▸ subscribe(type: string, method: string, params: Array<any>, callback: ProviderInterface$Callback): Promise<number>

-

Defined in ws/index.ts:195

+

Defined in ws/index.ts:195

name: subscribe

summary: Allows subscribing to a specific event.

example:

@@ -576,7 +576,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]

unsubscribe

▸ unsubscribe(type: string, method: string, id: number): Promise<boolean>

-

Defined in ws/index.ts:204

+

Defined in ws/index.ts:204

summary: Allows unsubscribing to subscriptions made with subscribe.

Parameters:

@@ -646,7 +646,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]] diff --git a/docs/rpc-provider/classes/_ws_index_.wsprovider.md b/docs/rpc-provider/classes/_ws_index_.wsprovider.md index 7dac6c0110..3bc8503f8b 100644 --- a/docs/rpc-provider/classes/_ws_index_.wsprovider.md +++ b/docs/rpc-provider/classes/_ws_index_.wsprovider.md @@ -34,7 +34,7 @@ const api = new Api(provider); ⊕ **new WsProvider**(endpoint?: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md) -*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/ws/index.ts#L75)* +*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/ws/index.ts#L75)* **Parameters:** @@ -55,7 +55,7 @@ ___ ▸ **connect**(): `void` -*Defined in [ws/index.ts:103](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/ws/index.ts#L103)* +*Defined in [ws/index.ts:103](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/ws/index.ts#L103)* *__summary__*: Manually connect @@ -70,7 +70,7 @@ ___ ▸ **isConnected**(): `boolean` -*Defined in [ws/index.ts:120](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/ws/index.ts#L120)* +*Defined in [ws/index.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/ws/index.ts#L120)* *__summary__*: Whether the node is connected or not. @@ -84,7 +84,7 @@ ___ ▸ **on**(type: *`ProviderInterface$Emitted`*, sub: *`ProviderInterface$EmitCb`*): `void` -*Defined in [ws/index.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/ws/index.ts#L129)* +*Defined in [ws/index.ts:129](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/ws/index.ts#L129)* *__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function. @@ -104,7 +104,7 @@ ___ ▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`> -*Defined in [ws/index.ts:139](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/ws/index.ts#L139)* +*Defined in [ws/index.ts:139](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/ws/index.ts#L139)* *__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue. @@ -125,7 +125,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *`ProviderInterface$Callback`*): `Promise`<`number`> -*Defined in [ws/index.ts:195](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/ws/index.ts#L195)* +*Defined in [ws/index.ts:195](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/ws/index.ts#L195)* *__name__*: subscribe @@ -163,7 +163,7 @@ ___ ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [ws/index.ts:204](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-provider/src/ws/index.ts#L204)* +*Defined in [ws/index.ts:204](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-provider/src/ws/index.ts#L204)* *__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe). diff --git a/docs/rpc-provider/index.html b/docs/rpc-provider/index.html index a664ad0473..1e403563d7 100644 --- a/docs/rpc-provider/index.html +++ b/docs/rpc-provider/index.html @@ -462,7 +462,7 @@ diff --git a/docs/rpc-rx/classes/_index_.rpcrx.md b/docs/rpc-rx/classes/_index_.rpcrx.md index 0a147ae2b4..de69adec9b 100644 --- a/docs/rpc-rx/classes/_index_.rpcrx.md +++ b/docs/rpc-rx/classes/_index_.rpcrx.md @@ -32,7 +32,7 @@ const api = new RpcRx(provider); ⊕ **new RpcRx**(providerOrRpc?: * `Rpc` | `ProviderInterface`*): [RpcRx](_index_.rpcrx.md) -*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-rx/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-rx/src/index.ts#L45)* **Parameters:** @@ -52,7 +52,7 @@ ___ **● author**: *`RpcRxInterface$Section`* -*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-rx/src/index.ts#L42)* +*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-rx/src/index.ts#L42)* ___ @@ -61,7 +61,7 @@ ___ **● chain**: *`RpcRxInterface$Section`* -*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-rx/src/index.ts#L43)* +*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-rx/src/index.ts#L43)* ___ @@ -70,7 +70,7 @@ ___ **● state**: *`RpcRxInterface$Section`* -*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-rx/src/index.ts#L44)* +*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-rx/src/index.ts#L44)* ___ @@ -79,7 +79,7 @@ ___ **● system**: *`RpcRxInterface$Section`* -*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-rx/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-rx/src/index.ts#L45)* ___ @@ -91,7 +91,7 @@ ___ ▸ **isConnected**(): `BehaviorSubject`<`boolean`> -*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-rx/src/index.ts#L66)* +*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-rx/src/index.ts#L66)* **Returns:** `BehaviorSubject`<`boolean`> @@ -102,7 +102,7 @@ ___ ▸ **on**(type: *`RpcRxInterface$Events`*, handler: *`function`*): `void` -*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/de284fb/packages/rpc-rx/src/index.ts#L70)* +*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/73710b7/packages/rpc-rx/src/index.ts#L70)* **Parameters:** diff --git a/docs/type-extrinsics/modules/_frommetadata_.md b/docs/type-extrinsics/modules/_frommetadata_.md index 7b6977d3d3..a103ab6384 100644 --- a/docs/type-extrinsics/modules/_frommetadata_.md +++ b/docs/type-extrinsics/modules/_frommetadata_.md @@ -8,7 +8,7 @@ ▸ **fromMetadata**(metadata: *`Metadata`*): `Extrinsics` -*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/de284fb/packages/type-extrinsics/src/fromMetadata.ts#L20)* +*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/73710b7/packages/type-extrinsics/src/fromMetadata.ts#L20)* Extend a storage object with the storage modules & module functions present in the metadata. diff --git a/docs/type-extrinsics/modules/_utils_createunchecked_.md b/docs/type-extrinsics/modules/_utils_createunchecked_.md index 159f1de1d6..0e1720c3c4 100644 --- a/docs/type-extrinsics/modules/_utils_createunchecked_.md +++ b/docs/type-extrinsics/modules/_utils_createunchecked_.md @@ -8,7 +8,7 @@ ▸ **createDescriptor**(section: *`string`*, method: *`string`*, index: *`number`*, meta: *`FunctionMetadata`*): `ExtrinsicFunction` -*Defined in [utils/createUnchecked.ts:17](https://github.com/polkadot-js/api/blob/de284fb/packages/type-extrinsics/src/utils/createUnchecked.ts#L17)* +*Defined in [utils/createUnchecked.ts:17](https://github.com/polkadot-js/api/blob/73710b7/packages/type-extrinsics/src/utils/createUnchecked.ts#L17)* From the metadata of a function in the module's storage, generate the function that will return the an UncheckExtrinsic. diff --git a/docs/type-jsonrpc/modules/_create_method_.md b/docs/type-jsonrpc/modules/_create_method_.md index 4716b0371f..3922b2e0a5 100644 --- a/docs/type-jsonrpc/modules/_create_method_.md +++ b/docs/type-jsonrpc/modules/_create_method_.md @@ -8,7 +8,7 @@ ▸ **createMethod**(section: *`string`*, method: *`string`*, __namedParameters: *`object`*): `RpcMethod` -*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/type-jsonrpc/src/create/method.ts#L9)* +*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/type-jsonrpc/src/create/method.ts#L9)* **Parameters:** diff --git a/docs/type-jsonrpc/modules/_create_param_.md b/docs/type-jsonrpc/modules/_create_param_.md index 7fe1ddd6eb..51315dce99 100644 --- a/docs/type-jsonrpc/modules/_create_param_.md +++ b/docs/type-jsonrpc/modules/_create_param_.md @@ -8,7 +8,7 @@ ▸ **createParam**(name: *`string`*, type: *`CodecTypes`*, __namedParameters?: *`object`*): `RpcParam` -*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/de284fb/packages/type-jsonrpc/src/create/param.ts#L12)* +*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/73710b7/packages/type-jsonrpc/src/create/param.ts#L12)* **Parameters:** diff --git a/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md b/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md index fddbe5d5f3..04b1905259 100644 --- a/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md +++ b/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md @@ -13,7 +13,7 @@ **● isUnhashed**: * `undefined` | `false` | `true` * -*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/de284fb/packages/type-storage/src/utils/createFunction.ts#L14)* +*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/type-storage/src/utils/createFunction.ts#L14)* ___ @@ -23,7 +23,7 @@ ___ **● method**: * `undefined` | `string` * -*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/de284fb/packages/type-storage/src/utils/createFunction.ts#L15)* +*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/73710b7/packages/type-storage/src/utils/createFunction.ts#L15)* ___ diff --git a/docs/type-storage/modules/_frommetadata_.md b/docs/type-storage/modules/_frommetadata_.md index d63128f0aa..6ccae69252 100644 --- a/docs/type-storage/modules/_frommetadata_.md +++ b/docs/type-storage/modules/_frommetadata_.md @@ -8,7 +8,7 @@ ▸ **fromMetadata**(metadata: *`Metadata`*): `Storage` -*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/de284fb/packages/type-storage/src/fromMetadata.ts#L20)* +*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/73710b7/packages/type-storage/src/fromMetadata.ts#L20)* Extend a storage object with the storage modules & module functions present in the metadata. diff --git a/docs/type-storage/modules/_storage_.md b/docs/type-storage/modules/_storage_.md index 4b6395c7aa..cefbc02cd8 100644 --- a/docs/type-storage/modules/_storage_.md +++ b/docs/type-storage/modules/_storage_.md @@ -8,7 +8,7 @@ **storage**: *`object`* -*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/de284fb/packages/type-storage/src/storage.ts#L8)* +*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/73710b7/packages/type-storage/src/storage.ts#L8)* @@ -16,7 +16,7 @@ **● substrate**: *["substrate"](_substrate_.md)* -*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/type-storage/src/storage.ts#L9)* +*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/type-storage/src/storage.ts#L9)* ___ diff --git a/docs/type-storage/modules/_substrate_.md b/docs/type-storage/modules/_substrate_.md index 6600ced233..d7a01eec63 100644 --- a/docs/type-storage/modules/_substrate_.md +++ b/docs/type-storage/modules/_substrate_.md @@ -11,7 +11,7 @@ type: 'u32' }) -*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/de284fb/packages/type-storage/src/substrate.ts#L45)* +*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/type-storage/src/substrate.ts#L45)* ___ @@ -23,7 +23,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/de284fb/packages/type-storage/src/substrate.ts#L50)* +*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/type-storage/src/substrate.ts#L50)* ___ @@ -35,7 +35,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/de284fb/packages/type-storage/src/substrate.ts#L60)* +*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/73710b7/packages/type-storage/src/substrate.ts#L60)* ___ @@ -47,7 +47,7 @@ ___ type: 'Bytes' }) -*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/de284fb/packages/type-storage/src/substrate.ts#L35)* +*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/type-storage/src/substrate.ts#L35)* ___ @@ -59,7 +59,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/de284fb/packages/type-storage/src/substrate.ts#L55)* +*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/type-storage/src/substrate.ts#L55)* ___ @@ -71,7 +71,7 @@ ___ type: 'u64' }) -*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/de284fb/packages/type-storage/src/substrate.ts#L40)* +*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/73710b7/packages/type-storage/src/substrate.ts#L40)* ___ diff --git a/docs/type-storage/modules/_utils_createfunction_.md b/docs/type-storage/modules/_utils_createfunction_.md index 889f3cf0bd..184f06fef7 100644 --- a/docs/type-storage/modules/_utils_createfunction_.md +++ b/docs/type-storage/modules/_utils_createfunction_.md @@ -20,7 +20,7 @@ ▸ **createFunction**(section: *`Text`*, method: *`Text`*, meta: *`StorageFunctionMetadata`*, options?: *[CreateItemOptions](../interfaces/_utils_createfunction_.createitemoptions.md)*): `StorageFunction` -*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/de284fb/packages/type-storage/src/utils/createFunction.ts#L28)* +*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/73710b7/packages/type-storage/src/utils/createFunction.ts#L28)* From the schema of a function in the module's storage, generate the function that will return the correct storage key. diff --git a/docs/types/SUMMARY.md b/docs/types/SUMMARY.md index bddfa2ee68..6902b50744 100644 --- a/docs/types/SUMMARY.md +++ b/docs/types/SUMMARY.md @@ -191,8 +191,10 @@ * [Tuple](classes/_codec_tuple_.tuple.md) * ["codec/U8a"](modules/_codec_u8a_.md) * [U8a](classes/_codec_u8a_.u8a.md) +* ["codec/U8a.spec"](modules/_codec_u8a_spec_.md) * ["codec/U8aFixed"](modules/_codec_u8afixed_.md) * [U8aFixed](classes/_codec_u8afixed_.u8afixed.md) +* ["codec/U8aFixed.spec"](modules/_codec_u8afixed_spec_.md) * ["codec/UInt"](modules/_codec_uint_.md) * [UInt](classes/_codec_uint_.uint.md) * ["codec/Vector"](modules/_codec_vector_.md) diff --git a/docs/types/classes/_accountid_.accountid.md b/docs/types/classes/_accountid_.accountid.md index d486ea05e2..da9e11ab60 100644 --- a/docs/types/classes/_accountid_.accountid.md +++ b/docs/types/classes/_accountid_.accountid.md @@ -8,6 +8,13 @@ ↳ [AuthorityId](_authorityid_.authorityid.md) +# Implements + +* `Codec` + +# Indexable + +\[index: `number`\]: `number` # Constructors @@ -18,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [AccountId.ts:16](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountId.ts#L16)* +*Defined in [AccountId.ts:15](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountId.ts#L15)* **Parameters:** @@ -32,44 +39,118 @@ ___ # Properties - + -## raw +## BYTES_PER_ELEMENT -**● raw**: *`Uint8Array`* +**● BYTES_PER_ELEMENT**: *`number`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from Uint8Array.BYTES_PER_ELEMENT* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1886* + +The size in bytes of each element in the array. ___ + -# Accessors +## __@toStringTag - +**● __@toStringTag**: *"UInt8Array"* -## encodedLength +*Inherited from Uint8Array.[Symbol.toStringTag]* -getencodedLength(): `number` +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[encodedLength](_codec_u8afixed_.u8afixed.md#encodedlength)* +___ + -*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* +## buffer -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8aFixed.ts#L32)* +**● buffer**: *`ArrayBufferLike`* -**Returns:** `number` +*Inherited from Uint8Array.buffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1891* + +The ArrayBuffer instance referenced by the array. + +___ + + +## byteLength + +**● byteLength**: *`number`* + +*Inherited from Uint8Array.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1896* + +The length in bytes of the array. + +___ + + +## byteOffset + +**● byteOffset**: *`number`* + +*Inherited from Uint8Array.byteOffset* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1901* + +The offset in bytes of the array. ___ ## length -getlength(): `number` +**● length**: *`number`* -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* +*Inherited from Uint8Array.length* -*Defined in [codec/U8a.ts:31](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L31)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2000* + +The length of the array. + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* + +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* + +___ + +# Accessors + + + +## bitLength + +getbitLength(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + +___ + + +## encodedLength + +getencodedLength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* + +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L39)* **Returns:** `number` @@ -77,6 +158,550 @@ ___ # Methods + + +## __@iterator + +▸ **__@iterator**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.[Symbol.iterator]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* + +**Returns:** `IterableIterator`<`number`> + +___ + + +## copyWithin + +▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.copyWithin* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1912* + +Returns the this object after copying a section of the array identified by start and end to the same array starting at position target + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | +| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | +| `Optional` end | `undefined` | `number`| If not specified, length of the this object is used as its default value. | + +**Returns:** `this` + +___ + + +## entries + +▸ **entries**(): `IterableIterator`<[`number`, `number`]> + +*Inherited from Uint8Array.entries* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* + +Returns an array of key, value pairs for every entry in the array + +**Returns:** `IterableIterator`<[`number`, `number`]> + +___ + + +## every + +▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.every* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1922* + +Determines whether all the members of an array satisfy the specified test. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## fill + +▸ **fill**(value: *`number`*, start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.fill* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1932* + +Returns the this object after filling the section identified by start and end with value + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| value | `number` | value to fill array section with | +| `Optional` start | `undefined` | `number`| index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | +| `Optional` end | `undefined` | `number`| index to stop filling the array at. If end is negative, it is treated as length+end. | + +**Returns:** `this` + +___ + + +## filter + +▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.filter* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1941* + +Returns the elements of an array that meet the condition specified in a callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## find + +▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` | `undefined` + +*Inherited from Uint8Array.find* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1952* + +Returns the value of the first element in the array where predicate is true, and undefined otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` | `undefined` + +___ + + +## findIndex + +▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` + +*Inherited from Uint8Array.findIndex* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1963* + +Returns the index of the first element in the array where predicate is true, and -1 otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` + +___ + + +## forEach + +▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` + +*Inherited from Uint8Array.forEach* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* + +Performs the specified action for each element in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `void` + +___ + + +## includes + +▸ **includes**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `boolean` + +*Inherited from Uint8Array.includes* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* + +Determines whether an array includes a certain element, returning true or false as appropriate. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The element to search for. | +| `Optional` fromIndex | `undefined` | `number`| The position in this array at which to begin searching for searchElement. | + +**Returns:** `boolean` + +___ + + +## indexOf + +▸ **indexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.indexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1980* + +Returns the index of the first occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## join + +▸ **join**(separator?: * `undefined` | `string`*): `string` + +*Inherited from Uint8Array.join* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1987* + +Adds all the elements of an array separated by the specified separator string. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` separator | `undefined` | `string`| A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | + +**Returns:** `string` + +___ + + +## keys + +▸ **keys**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.keys* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* + +Returns an list of keys in the array + +**Returns:** `IterableIterator`<`number`> + +___ + + +## lastIndexOf + +▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.lastIndexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1995* + +Returns the index of the last occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## map + +▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.map* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2010* + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## reduce + +▸ **reduce**(callbackfn: *`function`*): `number` + +▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2022* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2023* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2035* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reduceRight + +▸ **reduceRight**(callbackfn: *`function`*): `number` + +▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2047* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2060* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reverse + +▸ **reverse**(): `Uint8Array` + +*Inherited from Uint8Array.reverse* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2065* + +Reverses the elements in an Array. + +**Returns:** `Uint8Array` + +___ + + +## set + +▸ **set**(array: *`ArrayLike`<`number`>*, offset?: * `undefined` | `number`*): `void` + +*Inherited from Uint8Array.set* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2072* + +Sets a value or an array of values. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | +| `Optional` offset | `undefined` | `number`| The index in the current array at which the values are to be written. | + +**Returns:** `void` + +___ + + +## slice + +▸ **slice**(start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.slice* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2079* + +Returns a section of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` start | `undefined` | `number`| The beginning of the specified portion of the array. | +| `Optional` end | `undefined` | `number`| The end of the specified portion of the array. | + +**Returns:** `Uint8Array` + +___ + + +## some + +▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.some* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2089* + +Determines whether the specified callback function returns true for any element of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## sort + +▸ **sort**(compareFn?: * `undefined` | `function`*): `this` + +*Inherited from Uint8Array.sort* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2096* + +Sorts an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` compareFn | `undefined` | `function`| The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | + +**Returns:** `this` + +___ + + +## subarray + +▸ **subarray**(begin: *`number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.subarray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2104* + +Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| begin | `number` | The index of the beginning of the array. | +| `Optional` end | `undefined` | `number`| The index of the end of the array. | + +**Returns:** `Uint8Array` + +___ ## toHex @@ -85,7 +710,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -98,10 +723,25 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [AccountId.ts:40](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountId.ts#L40)* +*Defined in [AccountId.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountId.ts#L39)* **Returns:** `any` +___ + + +## toLocaleString + +▸ **toLocaleString**(): `string` + +*Inherited from Uint8Array.toLocaleString* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2109* + +Converts a number to a string by using the current locale. + +**Returns:** `string` + ___ @@ -111,7 +751,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [AccountId.ts:44](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountId.ts#L44)* +*Defined in [AccountId.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountId.ts#L43)* **Returns:** `string` @@ -124,9 +764,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L51)* **Parameters:** @@ -137,40 +775,19 @@ ___ **Returns:** `Uint8Array` ___ - + -## `` decodeAccountId +## values -▸ **decodeAccountId**(value: *`AnyU8a`*): `Uint8Array` +▸ **values**(): `IterableIterator`<`number`> -*Defined in [AccountId.ts:28](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountId.ts#L28)* +*Inherited from Uint8Array.values* -**Parameters:** +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* -| Param | Type | -| ------ | ------ | -| value | `AnyU8a` | +Returns an list of values in the array -**Returns:** `Uint8Array` - -___ - - -## `` decodeU8a - -▸ **decodeU8a**(value: *`any`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)* - -*Defined in [codec/U8a.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L21)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** `Uint8Array` +**Returns:** `IterableIterator`<`number`> ___ @@ -179,7 +796,7 @@ ___ ▸ **encode**(value: *`Uint8Array`*): `string` -*Defined in [AccountId.ts:24](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountId.ts#L24)* +*Defined in [AccountId.ts:23](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountId.ts#L23)* **Parameters:** diff --git a/docs/types/classes/_accountindex_.accountindex.md b/docs/types/classes/_accountindex_.accountindex.md index 4805cd2d40..997878a1b8 100644 --- a/docs/types/classes/_accountindex_.accountindex.md +++ b/docs/types/classes/_accountindex_.accountindex.md @@ -16,7 +16,7 @@ *Overrides [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* -*Defined in [AccountIndex.ts:27](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountIndex.ts#L27)* +*Defined in [AccountIndex.ts:26](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountIndex.ts#L26)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -52,7 +52,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -67,7 +67,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -83,7 +83,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -102,7 +102,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -121,7 +121,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -140,7 +140,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -159,7 +159,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -178,7 +178,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -197,7 +197,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -210,7 +210,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -229,7 +229,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -248,7 +248,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -267,7 +267,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -286,7 +286,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -299,7 +299,7 @@ ___ *Overrides [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [AccountIndex.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountIndex.ts#L89)* +*Defined in [AccountIndex.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountIndex.ts#L86)* **Returns:** `string` @@ -312,7 +312,7 @@ ___ *Overrides [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* -*Defined in [AccountIndex.ts:93](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountIndex.ts#L93)* +*Defined in [AccountIndex.ts:90](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountIndex.ts#L90)* **Returns:** `any` @@ -325,7 +325,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -338,7 +338,7 @@ ___ *Overrides [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* -*Defined in [AccountIndex.ts:97](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountIndex.ts#L97)* +*Defined in [AccountIndex.ts:94](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountIndex.ts#L94)* **Returns:** `string` @@ -351,7 +351,7 @@ ___ *Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Defined in [AccountIndex.ts:103](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountIndex.ts#L103)* +*Defined in [AccountIndex.ts:100](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountIndex.ts#L100)* **Parameters:** @@ -368,7 +368,7 @@ ___ ▸ **calcLength**(_value: * `BN` | `number`*): `number` -*Defined in [AccountIndex.ts:50](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountIndex.ts#L50)* +*Defined in [AccountIndex.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountIndex.ts#L47)* **Parameters:** @@ -385,7 +385,7 @@ ___ ▸ **decodeAccountIndex**(value: *`AnyNumber`*): `BN` | `Uint8Array` | `number` | `string` -*Defined in [AccountIndex.ts:34](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountIndex.ts#L34)* +*Defined in [AccountIndex.ts:33](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountIndex.ts#L33)* **Parameters:** @@ -404,7 +404,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** @@ -422,7 +422,7 @@ ___ ▸ **readLength**(input: *`Uint8Array`*): [`number`, `number`] -*Defined in [AccountIndex.ts:64](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountIndex.ts#L64)* +*Defined in [AccountIndex.ts:61](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountIndex.ts#L61)* **Parameters:** @@ -439,7 +439,7 @@ ___ ▸ **writeLength**(input: *`Uint8Array`*): `Uint8Array` -*Defined in [AccountIndex.ts:78](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountIndex.ts#L78)* +*Defined in [AccountIndex.ts:75](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountIndex.ts#L75)* **Parameters:** diff --git a/docs/types/classes/_address_.address.md b/docs/types/classes/_address_.address.md index 4d27019497..89e68de9c5 100644 --- a/docs/types/classes/_address_.address.md +++ b/docs/types/classes/_address_.address.md @@ -16,7 +16,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Address.ts:23](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Address.ts#L23)* +*Defined in [Address.ts:22](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Address.ts#L22)* **Parameters:** @@ -39,7 +39,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -53,7 +53,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [Address.ts:70](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Address.ts#L70)* +*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Address.ts#L67)* **Returns:** `number` @@ -64,7 +64,7 @@ ___ getrawLength(): `number` -*Defined in [Address.ts:64](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Address.ts#L64)* +*Defined in [Address.ts:61](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Address.ts#L61)* **Returns:** `number` @@ -78,7 +78,7 @@ ___ ▸ **toHex**(): `string` -*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Address.ts#L81)* +*Defined in [Address.ts:78](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Address.ts#L78)* **Returns:** `string` @@ -91,7 +91,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [Address.ts:85](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Address.ts#L85)* +*Defined in [Address.ts:82](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Address.ts#L82)* **Returns:** `any` @@ -104,7 +104,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [Address.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Address.ts#L89)* +*Defined in [Address.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Address.ts#L86)* **Returns:** `string` @@ -117,7 +117,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [Address.ts:93](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Address.ts#L93)* +*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Address.ts#L90)* **Parameters:** @@ -134,7 +134,7 @@ ___ ▸ **decodeAddress**(value: *`AnyAddress`*): [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) -*Defined in [Address.ts:30](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Address.ts#L30)* +*Defined in [Address.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Address.ts#L29)* **Parameters:** diff --git a/docs/types/classes/_authorityid_.authorityid.md b/docs/types/classes/_authorityid_.authorityid.md index 937e35c6d6..47328ab0bc 100644 --- a/docs/types/classes/_authorityid_.authorityid.md +++ b/docs/types/classes/_authorityid_.authorityid.md @@ -6,6 +6,13 @@ **↳ AuthorityId** +# Implements + +* `Codec` + +# Indexable + +\[index: `number`\]: `number` # Constructors @@ -18,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [AccountId.ts:16](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountId.ts#L16)* +*Defined in [AccountId.ts:15](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountId.ts#L15)* **Parameters:** @@ -32,44 +39,118 @@ ___ # Properties - + -## raw +## BYTES_PER_ELEMENT -**● raw**: *`Uint8Array`* +**● BYTES_PER_ELEMENT**: *`number`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from Uint8Array.BYTES_PER_ELEMENT* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1886* + +The size in bytes of each element in the array. ___ + -# Accessors +## __@toStringTag - +**● __@toStringTag**: *"UInt8Array"* -## encodedLength +*Inherited from Uint8Array.[Symbol.toStringTag]* -getencodedLength(): `number` +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[encodedLength](_codec_u8afixed_.u8afixed.md#encodedlength)* +___ + -*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* +## buffer -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8aFixed.ts#L32)* +**● buffer**: *`ArrayBufferLike`* -**Returns:** `number` +*Inherited from Uint8Array.buffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1891* + +The ArrayBuffer instance referenced by the array. + +___ + + +## byteLength + +**● byteLength**: *`number`* + +*Inherited from Uint8Array.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1896* + +The length in bytes of the array. + +___ + + +## byteOffset + +**● byteOffset**: *`number`* + +*Inherited from Uint8Array.byteOffset* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1901* + +The offset in bytes of the array. ___ ## length -getlength(): `number` +**● length**: *`number`* -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* +*Inherited from Uint8Array.length* -*Defined in [codec/U8a.ts:31](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L31)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2000* + +The length of the array. + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* + +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* + +___ + +# Accessors + + + +## bitLength + +getbitLength(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + +___ + + +## encodedLength + +getencodedLength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* + +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L39)* **Returns:** `number` @@ -77,6 +158,550 @@ ___ # Methods + + +## __@iterator + +▸ **__@iterator**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.[Symbol.iterator]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* + +**Returns:** `IterableIterator`<`number`> + +___ + + +## copyWithin + +▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.copyWithin* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1912* + +Returns the this object after copying a section of the array identified by start and end to the same array starting at position target + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | +| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | +| `Optional` end | `undefined` | `number`| If not specified, length of the this object is used as its default value. | + +**Returns:** `this` + +___ + + +## entries + +▸ **entries**(): `IterableIterator`<[`number`, `number`]> + +*Inherited from Uint8Array.entries* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* + +Returns an array of key, value pairs for every entry in the array + +**Returns:** `IterableIterator`<[`number`, `number`]> + +___ + + +## every + +▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.every* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1922* + +Determines whether all the members of an array satisfy the specified test. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## fill + +▸ **fill**(value: *`number`*, start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.fill* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1932* + +Returns the this object after filling the section identified by start and end with value + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| value | `number` | value to fill array section with | +| `Optional` start | `undefined` | `number`| index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | +| `Optional` end | `undefined` | `number`| index to stop filling the array at. If end is negative, it is treated as length+end. | + +**Returns:** `this` + +___ + + +## filter + +▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.filter* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1941* + +Returns the elements of an array that meet the condition specified in a callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## find + +▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` | `undefined` + +*Inherited from Uint8Array.find* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1952* + +Returns the value of the first element in the array where predicate is true, and undefined otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` | `undefined` + +___ + + +## findIndex + +▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` + +*Inherited from Uint8Array.findIndex* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1963* + +Returns the index of the first element in the array where predicate is true, and -1 otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` + +___ + + +## forEach + +▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` + +*Inherited from Uint8Array.forEach* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* + +Performs the specified action for each element in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `void` + +___ + + +## includes + +▸ **includes**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `boolean` + +*Inherited from Uint8Array.includes* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* + +Determines whether an array includes a certain element, returning true or false as appropriate. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The element to search for. | +| `Optional` fromIndex | `undefined` | `number`| The position in this array at which to begin searching for searchElement. | + +**Returns:** `boolean` + +___ + + +## indexOf + +▸ **indexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.indexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1980* + +Returns the index of the first occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## join + +▸ **join**(separator?: * `undefined` | `string`*): `string` + +*Inherited from Uint8Array.join* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1987* + +Adds all the elements of an array separated by the specified separator string. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` separator | `undefined` | `string`| A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | + +**Returns:** `string` + +___ + + +## keys + +▸ **keys**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.keys* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* + +Returns an list of keys in the array + +**Returns:** `IterableIterator`<`number`> + +___ + + +## lastIndexOf + +▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.lastIndexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1995* + +Returns the index of the last occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## map + +▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.map* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2010* + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## reduce + +▸ **reduce**(callbackfn: *`function`*): `number` + +▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2022* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2023* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2035* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reduceRight + +▸ **reduceRight**(callbackfn: *`function`*): `number` + +▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2047* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2060* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reverse + +▸ **reverse**(): `Uint8Array` + +*Inherited from Uint8Array.reverse* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2065* + +Reverses the elements in an Array. + +**Returns:** `Uint8Array` + +___ + + +## set + +▸ **set**(array: *`ArrayLike`<`number`>*, offset?: * `undefined` | `number`*): `void` + +*Inherited from Uint8Array.set* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2072* + +Sets a value or an array of values. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | +| `Optional` offset | `undefined` | `number`| The index in the current array at which the values are to be written. | + +**Returns:** `void` + +___ + + +## slice + +▸ **slice**(start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.slice* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2079* + +Returns a section of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` start | `undefined` | `number`| The beginning of the specified portion of the array. | +| `Optional` end | `undefined` | `number`| The end of the specified portion of the array. | + +**Returns:** `Uint8Array` + +___ + + +## some + +▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.some* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2089* + +Determines whether the specified callback function returns true for any element of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## sort + +▸ **sort**(compareFn?: * `undefined` | `function`*): `this` + +*Inherited from Uint8Array.sort* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2096* + +Sorts an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` compareFn | `undefined` | `function`| The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | + +**Returns:** `this` + +___ + + +## subarray + +▸ **subarray**(begin: *`number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.subarray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2104* + +Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| begin | `number` | The index of the beginning of the array. | +| `Optional` end | `undefined` | `number`| The index of the end of the array. | + +**Returns:** `Uint8Array` + +___ ## toHex @@ -85,7 +710,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -100,10 +725,25 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [AccountId.ts:40](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountId.ts#L40)* +*Defined in [AccountId.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountId.ts#L39)* **Returns:** `any` +___ + + +## toLocaleString + +▸ **toLocaleString**(): `string` + +*Inherited from Uint8Array.toLocaleString* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2109* + +Converts a number to a string by using the current locale. + +**Returns:** `string` + ___ @@ -115,7 +755,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [AccountId.ts:44](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountId.ts#L44)* +*Defined in [AccountId.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountId.ts#L43)* **Returns:** `string` @@ -128,9 +768,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L51)* **Parameters:** @@ -141,42 +779,19 @@ ___ **Returns:** `Uint8Array` ___ - + -## `` decodeAccountId +## values -▸ **decodeAccountId**(value: *`AnyU8a`*): `Uint8Array` +▸ **values**(): `IterableIterator`<`number`> -*Inherited from [AccountId](_accountid_.accountid.md).[decodeAccountId](_accountid_.accountid.md#decodeaccountid)* +*Inherited from Uint8Array.values* -*Defined in [AccountId.ts:28](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountId.ts#L28)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* -**Parameters:** +Returns an list of values in the array -| Param | Type | -| ------ | ------ | -| value | `AnyU8a` | - -**Returns:** `Uint8Array` - -___ - - -## `` decodeU8a - -▸ **decodeU8a**(value: *`any`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)* - -*Defined in [codec/U8a.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L21)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** `Uint8Array` +**Returns:** `IterableIterator`<`number`> ___ @@ -187,7 +802,7 @@ ___ *Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)* -*Defined in [AccountId.ts:24](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountId.ts#L24)* +*Defined in [AccountId.ts:23](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountId.ts#L23)* **Parameters:** diff --git a/docs/types/classes/_balance_.balance.md b/docs/types/classes/_balance_.balance.md index 2875a335d5..9dd40b7dfd 100644 --- a/docs/types/classes/_balance_.balance.md +++ b/docs/types/classes/_balance_.balance.md @@ -18,7 +18,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U128.ts#L9)* +*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U128.ts#L9)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -69,7 +69,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -85,7 +85,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -104,7 +104,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -123,7 +123,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -142,7 +142,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -161,7 +161,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -180,7 +180,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -199,7 +199,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -212,7 +212,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -231,7 +231,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -250,7 +250,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -269,7 +269,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -288,7 +288,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -301,7 +301,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -316,7 +316,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -329,7 +329,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -344,7 +344,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -359,7 +359,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -378,7 +378,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_bft_.bftauthoritysignature.md b/docs/types/classes/_bft_.bftauthoritysignature.md index f84f758952..b167e3a561 100644 --- a/docs/types/classes/_bft_.bftauthoritysignature.md +++ b/docs/types/classes/_bft_.bftauthoritysignature.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Bft.ts:23](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bft.ts#L23)* +*Defined in [Bft.ts:23](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bft.ts#L23)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getauthorityId(): [AuthorityId](_authorityid_.authorityid.md) -*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bft.ts#L31)* +*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bft.ts#L31)* **Returns:** [AuthorityId](_authorityid_.authorityid.md) @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [Bft.ts:35](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bft.ts#L35)* +*Defined in [Bft.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bft.ts#L35)* **Returns:** [Signature](_signature_.signature.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -336,7 +336,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Tuple.ts#L28)* +*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Tuple.ts#L28)* **Returns:** `any` @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -398,7 +398,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Tuple.ts#L18)* +*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Tuple.ts#L18)* **Type parameters:** diff --git a/docs/types/classes/_bft_.bfthashsignature.md b/docs/types/classes/_bft_.bfthashsignature.md index 1136a31656..c7f1ffadb9 100644 --- a/docs/types/classes/_bft_.bfthashsignature.md +++ b/docs/types/classes/_bft_.bfthashsignature.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Bft.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bft.ts#L47)* +*Defined in [Bft.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bft.ts#L47)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Bft.ts:55](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bft.ts#L55)* +*Defined in [Bft.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bft.ts#L55)* **Returns:** [Hash](_hash_.hash.md) @@ -118,7 +118,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [Bft.ts:59](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bft.ts#L59)* +*Defined in [Bft.ts:59](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bft.ts#L59)* **Returns:** [Signature](_signature_.signature.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -336,7 +336,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Tuple.ts#L28)* +*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Tuple.ts#L28)* **Returns:** `any` @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -398,7 +398,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Tuple.ts#L18)* +*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Tuple.ts#L18)* **Type parameters:** diff --git a/docs/types/classes/_bft_.justification.md b/docs/types/classes/_bft_.justification.md index ecde47bb65..3abc7c3db0 100644 --- a/docs/types/classes/_bft_.justification.md +++ b/docs/types/classes/_bft_.justification.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Bft.ts:70](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bft.ts#L70)* +*Defined in [Bft.ts:70](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bft.ts#L70)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Bft.ts:81](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bft.ts#L81)* +*Defined in [Bft.ts:81](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bft.ts#L81)* **Returns:** [Hash](_hash_.hash.md) @@ -118,7 +118,7 @@ ___ getround(): [U32](_u32_.u32.md) -*Defined in [Bft.ts:85](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bft.ts#L85)* +*Defined in [Bft.ts:85](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bft.ts#L85)* **Returns:** [U32](_u32_.u32.md) @@ -129,7 +129,7 @@ ___ getsignatures(): [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_bft_.bftauthoritysignature.md)> -*Defined in [Bft.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bft.ts#L89)* +*Defined in [Bft.ts:89](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bft.ts#L89)* **Returns:** [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_bft_.bftauthoritysignature.md)> @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -319,7 +319,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -358,7 +358,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -371,7 +371,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -405,7 +405,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_block_.block.md b/docs/types/classes/_block_.block.md index 038f3ef6db..f584e84b39 100644 --- a/docs/types/classes/_block_.block.md +++ b/docs/types/classes/_block_.block.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Block.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Block.ts#L21)* +*Defined in [Block.ts:21](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Block.ts#L21)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getextrinsics(): [Extrinsics](_extrinsics_.extrinsics.md) -*Defined in [Block.ts:29](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Block.ts#L29)* +*Defined in [Block.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Block.ts#L29)* **Returns:** [Extrinsics](_extrinsics_.extrinsics.md) @@ -118,7 +118,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Block.ts:34](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Block.ts#L34)* +*Defined in [Block.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Block.ts#L34)* **Returns:** [Hash](_hash_.hash.md) @@ -129,7 +129,7 @@ ___ getheader(): [Header](_header_.header.md) -*Defined in [Block.ts:40](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Block.ts#L40)* +*Defined in [Block.ts:40](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Block.ts#L40)* **Returns:** [Header](_header_.header.md) @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -319,7 +319,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -358,7 +358,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -371,7 +371,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -405,7 +405,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_blocknumber_.blocknumber.md b/docs/types/classes/_blocknumber_.blocknumber.md index 8fe2cb05c8..e156ccbc74 100644 --- a/docs/types/classes/_blocknumber_.blocknumber.md +++ b/docs/types/classes/_blocknumber_.blocknumber.md @@ -18,7 +18,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U64.ts#L9)* +*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U64.ts#L9)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -69,7 +69,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -85,7 +85,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -104,7 +104,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -123,7 +123,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -142,7 +142,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -161,7 +161,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -180,7 +180,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -199,7 +199,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -212,7 +212,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -231,7 +231,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -250,7 +250,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -269,7 +269,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -288,7 +288,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -301,7 +301,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -316,7 +316,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -329,7 +329,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -344,7 +344,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -359,7 +359,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -378,7 +378,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_bool_.bool.md b/docs/types/classes/_bool_.bool.md index b172b6a30f..d0c798a4e6 100644 --- a/docs/types/classes/_bool_.bool.md +++ b/docs/types/classes/_bool_.bool.md @@ -12,17 +12,17 @@ ## constructor -⊕ **new Bool**(value?: * [Bool](_bool_.bool.md) | [U8a](_codec_u8a_.u8a.md) | `Boolean` | `Uint8Array` | `boolean`*): [Bool](_bool_.bool.md) +⊕ **new Bool**(value?: * [Bool](_bool_.bool.md) | `Boolean` | `Uint8Array` | `boolean`*): [Bool](_bool_.bool.md) *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Bool.ts:10](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bool.ts#L10)* +*Defined in [Bool.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bool.ts#L9)* **Parameters:** | Param | Type | Default value | | ------ | ------ | ------ | -| `Default value` value | [Bool](_bool_.bool.md) | [U8a](_codec_u8a_.u8a.md) | `Boolean` | `Uint8Array` | `boolean`| false | +| `Default value` value | [Bool](_bool_.bool.md) | `Boolean` | `Uint8Array` | `boolean`| false | **Returns:** [Bool](_bool_.bool.md) @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -52,7 +52,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [Bool.ts:29](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bool.ts#L29)* +*Defined in [Bool.ts:26](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bool.ts#L26)* **Returns:** `number` @@ -68,7 +68,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [Bool.ts:33](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bool.ts#L33)* +*Defined in [Bool.ts:30](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bool.ts#L30)* **Returns:** `any` @@ -81,7 +81,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [Bool.ts:41](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bool.ts#L41)* +*Defined in [Bool.ts:38](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bool.ts#L38)* **Returns:** `string` @@ -94,7 +94,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [Bool.ts:37](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bool.ts#L37)* +*Defined in [Bool.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bool.ts#L34)* **Parameters:** @@ -111,7 +111,7 @@ ___ ▸ **valueOf**(): `boolean` -*Defined in [Bool.ts:45](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bool.ts#L45)* +*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bool.ts#L42)* **Returns:** `boolean` @@ -122,7 +122,7 @@ ___ ▸ **decodeBool**(value: *`any`*): `boolean` -*Defined in [Bool.ts:17](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bool.ts#L17)* +*Defined in [Bool.ts:16](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bool.ts#L16)* **Parameters:** diff --git a/docs/types/classes/_bytes_.bytes.md b/docs/types/classes/_bytes_.bytes.md index be5fe345d3..a560806e77 100644 --- a/docs/types/classes/_bytes_.bytes.md +++ b/docs/types/classes/_bytes_.bytes.md @@ -10,6 +10,13 @@ ↳ [StorageKey](_storagekey_.storagekey.md) +# Implements + +* `Codec` + +# Indexable + +\[index: `number`\]: `number` # Constructors @@ -20,7 +27,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:14](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bytes.ts#L14)* +*Defined in [Bytes.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bytes.ts#L14)* **Parameters:** @@ -34,15 +41,91 @@ ___ # Properties + + +## BYTES_PER_ELEMENT + +**● BYTES_PER_ELEMENT**: *`number`* + +*Inherited from Uint8Array.BYTES_PER_ELEMENT* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1886* + +The size in bytes of each element in the array. + +___ + + +## __@toStringTag + +**● __@toStringTag**: *"UInt8Array"* + +*Inherited from Uint8Array.[Symbol.toStringTag]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* + +___ + + +## buffer + +**● buffer**: *`ArrayBufferLike`* + +*Inherited from Uint8Array.buffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1891* + +The ArrayBuffer instance referenced by the array. + +___ + + +## byteLength + +**● byteLength**: *`number`* + +*Inherited from Uint8Array.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1896* + +The length in bytes of the array. + +___ + + +## byteOffset + +**● byteOffset**: *`number`* + +*Inherited from Uint8Array.byteOffset* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1901* + +The offset in bytes of the array. + +___ + + +## length + +**● length**: *`number`* + +*Inherited from Uint8Array.length* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2000* + +The length of the array. + +___ ## raw **● raw**: *`Uint8Array`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* ___ @@ -56,20 +139,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bytes.ts#L43)* - -**Returns:** `number` - -___ - - -## length - -getlength(): `number` - -*Overrides [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [Bytes.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bytes.ts#L39)* +*Defined in [Bytes.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bytes.ts#L39)* **Returns:** `number` @@ -77,6 +147,550 @@ ___ # Methods + + +## __@iterator + +▸ **__@iterator**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.[Symbol.iterator]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* + +**Returns:** `IterableIterator`<`number`> + +___ + + +## copyWithin + +▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.copyWithin* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1912* + +Returns the this object after copying a section of the array identified by start and end to the same array starting at position target + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | +| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | +| `Optional` end | `undefined` | `number`| If not specified, length of the this object is used as its default value. | + +**Returns:** `this` + +___ + + +## entries + +▸ **entries**(): `IterableIterator`<[`number`, `number`]> + +*Inherited from Uint8Array.entries* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* + +Returns an array of key, value pairs for every entry in the array + +**Returns:** `IterableIterator`<[`number`, `number`]> + +___ + + +## every + +▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.every* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1922* + +Determines whether all the members of an array satisfy the specified test. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## fill + +▸ **fill**(value: *`number`*, start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.fill* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1932* + +Returns the this object after filling the section identified by start and end with value + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| value | `number` | value to fill array section with | +| `Optional` start | `undefined` | `number`| index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | +| `Optional` end | `undefined` | `number`| index to stop filling the array at. If end is negative, it is treated as length+end. | + +**Returns:** `this` + +___ + + +## filter + +▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.filter* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1941* + +Returns the elements of an array that meet the condition specified in a callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## find + +▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` | `undefined` + +*Inherited from Uint8Array.find* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1952* + +Returns the value of the first element in the array where predicate is true, and undefined otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` | `undefined` + +___ + + +## findIndex + +▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` + +*Inherited from Uint8Array.findIndex* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1963* + +Returns the index of the first element in the array where predicate is true, and -1 otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` + +___ + + +## forEach + +▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` + +*Inherited from Uint8Array.forEach* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* + +Performs the specified action for each element in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `void` + +___ + + +## includes + +▸ **includes**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `boolean` + +*Inherited from Uint8Array.includes* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* + +Determines whether an array includes a certain element, returning true or false as appropriate. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The element to search for. | +| `Optional` fromIndex | `undefined` | `number`| The position in this array at which to begin searching for searchElement. | + +**Returns:** `boolean` + +___ + + +## indexOf + +▸ **indexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.indexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1980* + +Returns the index of the first occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## join + +▸ **join**(separator?: * `undefined` | `string`*): `string` + +*Inherited from Uint8Array.join* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1987* + +Adds all the elements of an array separated by the specified separator string. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` separator | `undefined` | `string`| A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | + +**Returns:** `string` + +___ + + +## keys + +▸ **keys**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.keys* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* + +Returns an list of keys in the array + +**Returns:** `IterableIterator`<`number`> + +___ + + +## lastIndexOf + +▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.lastIndexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1995* + +Returns the index of the last occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## map + +▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.map* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2010* + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## reduce + +▸ **reduce**(callbackfn: *`function`*): `number` + +▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2022* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2023* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2035* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reduceRight + +▸ **reduceRight**(callbackfn: *`function`*): `number` + +▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2047* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2060* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reverse + +▸ **reverse**(): `Uint8Array` + +*Inherited from Uint8Array.reverse* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2065* + +Reverses the elements in an Array. + +**Returns:** `Uint8Array` + +___ + + +## set + +▸ **set**(array: *`ArrayLike`<`number`>*, offset?: * `undefined` | `number`*): `void` + +*Inherited from Uint8Array.set* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2072* + +Sets a value or an array of values. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | +| `Optional` offset | `undefined` | `number`| The index in the current array at which the values are to be written. | + +**Returns:** `void` + +___ + + +## slice + +▸ **slice**(start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.slice* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2079* + +Returns a section of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` start | `undefined` | `number`| The beginning of the specified portion of the array. | +| `Optional` end | `undefined` | `number`| The end of the specified portion of the array. | + +**Returns:** `Uint8Array` + +___ + + +## some + +▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.some* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2089* + +Determines whether the specified callback function returns true for any element of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## sort + +▸ **sort**(compareFn?: * `undefined` | `function`*): `this` + +*Inherited from Uint8Array.sort* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2096* + +Sorts an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` compareFn | `undefined` | `function`| The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | + +**Returns:** `this` + +___ + + +## subarray + +▸ **subarray**(begin: *`number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.subarray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2104* + +Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| begin | `number` | The index of the beginning of the array. | +| `Optional` end | `undefined` | `number`| The index of the end of the array. | + +**Returns:** `Uint8Array` + +___ ## toHex @@ -85,7 +699,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -98,12 +712,25 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` +___ + + +## toLocaleString + +▸ **toLocaleString**(): `string` + +*Inherited from Uint8Array.toLocaleString* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2109* + +Converts a number to a string by using the current locale. + +**Returns:** `string` + ___ @@ -113,9 +740,9 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -128,7 +755,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bytes.ts#L47)* +*Defined in [Bytes.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bytes.ts#L43)* **Parameters:** @@ -139,40 +766,19 @@ ___ **Returns:** `Uint8Array` ___ - + -## `` decodeBytes +## values -▸ **decodeBytes**(value: *`AnyU8a`*): `Uint8Array` +▸ **values**(): `IterableIterator`<`number`> -*Defined in [Bytes.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bytes.ts#L19)* +*Inherited from Uint8Array.values* -**Parameters:** +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* -| Param | Type | -| ------ | ------ | -| value | `AnyU8a` | +Returns an list of values in the array -**Returns:** `Uint8Array` - -___ - - -## `` decodeU8a - -▸ **decodeU8a**(value: *`any`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)* - -*Defined in [codec/U8a.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L21)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** `Uint8Array` +**Returns:** `IterableIterator`<`number`> ___ diff --git a/docs/types/classes/_codec_base_.base.md b/docs/types/classes/_codec_base_.base.md index 1ad25bbe17..5cea418ca5 100644 --- a/docs/types/classes/_codec_base_.base.md +++ b/docs/types/classes/_codec_base_.base.md @@ -6,8 +6,6 @@ **Base** -↳ [U8a](_codec_u8a_.u8a.md) - ↳ [UInt](_codec_uint_.uint.md) ↳ [Address](_address_.address.md) @@ -42,7 +40,7 @@ ⊕ **new Base**(value?: *`any`*): [Base](_codec_base_.base.md) -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* **Parameters:** @@ -62,7 +60,7 @@ ___ **● raw**: *`T`* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -74,7 +72,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L25)* +*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L25)* **Returns:** `number` @@ -88,7 +86,7 @@ ___ ▸ **toJSON**(): `any` -*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L29)* +*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L29)* **Returns:** `any` @@ -99,7 +97,7 @@ ___ ▸ **toString**(): `string` -*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L33)* +*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L33)* **Returns:** `string` @@ -110,7 +108,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L37)* +*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_codec_compact_.compact.md b/docs/types/classes/_codec_compact_.compact.md index 61c9ae35b6..05138797ff 100644 --- a/docs/types/classes/_codec_compact_.compact.md +++ b/docs/types/classes/_codec_compact_.compact.md @@ -16,7 +16,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Compact.ts:35](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Compact.ts#L35)* +*Defined in [codec/Compact.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Compact.ts#L34)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -52,7 +52,7 @@ ___ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) -*Defined in [codec/Compact.ts:124](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Compact.ts#L124)* +*Defined in [codec/Compact.ts:121](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Compact.ts#L121)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -65,7 +65,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Compact.ts:128](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Compact.ts#L128)* +*Defined in [codec/Compact.ts:125](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Compact.ts#L125)* **Returns:** `number` @@ -79,7 +79,7 @@ ___ ▸ **toBn**(): `any` -*Defined in [codec/Compact.ts:132](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Compact.ts#L132)* +*Defined in [codec/Compact.ts:129](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Compact.ts#L129)* **Returns:** `any` @@ -90,7 +90,7 @@ ___ ▸ **toHex**(): `any` -*Defined in [codec/Compact.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Compact.ts#L136)* +*Defined in [codec/Compact.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Compact.ts#L133)* **Returns:** `any` @@ -103,7 +103,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Compact.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Compact.ts#L140)* +*Defined in [codec/Compact.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Compact.ts#L137)* **Returns:** `any` @@ -114,7 +114,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/Compact.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Compact.ts#L144)* +*Defined in [codec/Compact.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Compact.ts#L141)* **Returns:** `number` @@ -127,7 +127,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Compact.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Compact.ts#L148)* +*Defined in [codec/Compact.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Compact.ts#L145)* **Returns:** `string` @@ -140,7 +140,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Compact.ts:152](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Compact.ts#L152)* +*Defined in [codec/Compact.ts:149](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Compact.ts#L149)* **Parameters:** @@ -157,7 +157,7 @@ ___ ▸ **addLengthPrefix**(u8a: *`Uint8Array`*, bitLength?: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `Uint8Array` -*Defined in [codec/Compact.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Compact.ts#L53)* +*Defined in [codec/Compact.ts:52](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Compact.ts#L52)* Prepend a Uint8Array with its compact length. @@ -177,7 +177,7 @@ ___ ▸ **decodeCompact**(Type: *`Constructor`< [UInt](_codec_uint_.uint.md) | [Moment](_moment_.moment.md)>*, value: *`AnyNumber`*): [Moment](_moment_.moment.md) | [UInt](_codec_uint_.uint.md) -*Defined in [codec/Compact.ts:66](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Compact.ts#L66)* +*Defined in [codec/Compact.ts:65](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Compact.ts#L65)* **Parameters:** @@ -195,7 +195,7 @@ ___ ▸ **decodeU8a**(_input: * `Uint8Array` | `string`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): [`number`, `BN`] -*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Compact.ts#L86)* +*Defined in [codec/Compact.ts:83](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Compact.ts#L83)* **Parameters:** @@ -213,7 +213,7 @@ ___ ▸ **encodeU8a**(_value: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `Uint8Array` -*Defined in [codec/Compact.ts:103](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Compact.ts#L103)* +*Defined in [codec/Compact.ts:100](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Compact.ts#L100)* **Parameters:** @@ -231,7 +231,7 @@ ___ ▸ **stripLengthPrefix**(u8a: *`Uint8Array`*, bitLength?: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `Uint8Array` -*Defined in [codec/Compact.ts:60](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Compact.ts#L60)* +*Defined in [codec/Compact.ts:59](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Compact.ts#L59)* **Parameters:** @@ -249,7 +249,7 @@ ___ ▸ **with**(Type: *`Constructor`< [UInt](_codec_uint_.uint.md) | [Moment](_moment_.moment.md)>*): `Constructor`<[Compact](_codec_compact_.compact.md)> -*Defined in [codec/Compact.ts:40](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Compact.ts#L40)* +*Defined in [codec/Compact.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Compact.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_codec_enum_.enum.md b/docs/types/classes/_codec_enum_.enum.md index a54468257b..b17bafa7fb 100644 --- a/docs/types/classes/_codec_enum_.enum.md +++ b/docs/types/classes/_codec_enum_.enum.md @@ -18,18 +18,18 @@ ## constructor -⊕ **new Enum**(def: *`EnumDef`*, value?: * [Enum](_codec_enum_.enum.md) | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `number`*): [Enum](_codec_enum_.enum.md) +⊕ **new Enum**(def: *`EnumDef`*, value?: * [Enum](_codec_enum_.enum.md) | `Uint8Array` | `number`*): [Enum](_codec_enum_.enum.md) *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Enum.ts:22](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L22)* +*Defined in [codec/Enum.ts:21](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L21)* **Parameters:** | Param | Type | Default value | | ------ | ------ | ------ | | def | `EnumDef` | - | -| `Default value` value | [Enum](_codec_enum_.enum.md) | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `number`| 0 | +| `Default value` value | [Enum](_codec_enum_.enum.md) | `Uint8Array` | `number`| 0 | **Returns:** [Enum](_codec_enum_.enum.md) @@ -45,7 +45,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -59,7 +59,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Enum.ts:44](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L44)* +*Defined in [codec/Enum.ts:41](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L41)* **Returns:** `number` @@ -75,7 +75,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Enum.ts:48](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L48)* +*Defined in [codec/Enum.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L45)* **Returns:** `any` @@ -86,7 +86,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/Enum.ts:52](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L52)* +*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L49)* **Returns:** `number` @@ -99,7 +99,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Enum.ts:56](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L56)* +*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L53)* **Returns:** `string` @@ -112,7 +112,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Enum.ts:60](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L60)* +*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L57)* **Parameters:** @@ -127,15 +127,15 @@ ___ ## `` decodeEnum -▸ **decodeEnum**(value?: * [Enum](_codec_enum_.enum.md) | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `number`*): `number` +▸ **decodeEnum**(value?: * [Enum](_codec_enum_.enum.md) | `Uint8Array` | `number`*): `number` -*Defined in [codec/Enum.ts:32](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L32)* +*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L31)* **Parameters:** | Param | Type | Default value | | ------ | ------ | ------ | -| `Default value` value | [Enum](_codec_enum_.enum.md) | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `number`| 0 | +| `Default value` value | [Enum](_codec_enum_.enum.md) | `Uint8Array` | `number`| 0 | **Returns:** `number` diff --git a/docs/types/classes/_codec_enumtype_.enumtype.md b/docs/types/classes/_codec_enumtype_.enumtype.md index ef7257d881..dfe0d52e63 100644 --- a/docs/types/classes/_codec_enumtype_.enumtype.md +++ b/docs/types/classes/_codec_enumtype_.enumtype.md @@ -26,7 +26,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/EnumType.ts:27](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L27)* +*Defined in [codec/EnumType.ts:26](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L26)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -64,7 +64,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L97)* +*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L94)* **Returns:** `number` @@ -75,7 +75,7 @@ ___ getisNull(): `boolean` -*Defined in [codec/EnumType.ts:85](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L85)* +*Defined in [codec/EnumType.ts:82](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L82)* **Returns:** `boolean` @@ -86,7 +86,7 @@ ___ gettype(): `string` -*Defined in [codec/EnumType.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L89)* +*Defined in [codec/EnumType.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L86)* **Returns:** `string` @@ -97,7 +97,7 @@ ___ getvalue(): [Base](_codec_base_.base.md)<`T`> -*Defined in [codec/EnumType.ts:93](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L93)* +*Defined in [codec/EnumType.ts:90](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L90)* **Returns:** [Base](_codec_base_.base.md)<`T`> @@ -111,7 +111,7 @@ ___ ▸ **setValue**(index?: * [EnumType](_codec_enumtype_.enumtype.md)<`T`> | `number`*, value?: *`any`*): `void` -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L98)* **Parameters:** @@ -131,7 +131,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L118)* +*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L115)* **Returns:** `any` @@ -142,7 +142,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/EnumType.ts:122](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L122)* +*Defined in [codec/EnumType.ts:119](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L119)* **Returns:** `number` @@ -155,7 +155,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/EnumType.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L126)* +*Defined in [codec/EnumType.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L123)* **Returns:** `string` @@ -168,7 +168,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/EnumType.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L130)* +*Defined in [codec/EnumType.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L127)* **Parameters:** @@ -185,7 +185,7 @@ ___ ▸ **decodeEnumType**<`T`>(def: *`TypesDef`*, value?: *`any`*, index?: * `number` | [EnumType](_codec_enumtype_.enumtype.md)<`T`>*): `object` -*Defined in [codec/EnumType.ts:46](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L46)* +*Defined in [codec/EnumType.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L45)* **Type parameters:** diff --git a/docs/types/classes/_codec_option_.option.md b/docs/types/classes/_codec_option_.option.md index 45663a4d8f..db7ec6e56f 100644 --- a/docs/types/classes/_codec_option_.option.md +++ b/docs/types/classes/_codec_option_.option.md @@ -18,7 +18,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Option.ts:16](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Option.ts#L16)* +*Defined in [codec/Option.ts:16](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Option.ts#L16)* **Parameters:** @@ -41,7 +41,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -55,7 +55,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Option.ts:60](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Option.ts#L60)* +*Defined in [codec/Option.ts:60](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Option.ts#L60)* **Returns:** `number` @@ -66,7 +66,7 @@ ___ getisEmpty(): `boolean` -*Defined in [codec/Option.ts:50](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Option.ts#L50)* +*Defined in [codec/Option.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Option.ts#L50)* **Returns:** `boolean` @@ -77,7 +77,7 @@ ___ getvalue(): [Base](_codec_base_.base.md)<`T`> | `undefined` -*Defined in [codec/Option.ts:54](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Option.ts#L54)* +*Defined in [codec/Option.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Option.ts#L54)* **Returns:** [Base](_codec_base_.base.md)<`T`> | `undefined` @@ -93,7 +93,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Option.ts:68](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Option.ts#L68)* +*Defined in [codec/Option.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Option.ts#L68)* **Returns:** `any` @@ -106,7 +106,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Option.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Option.ts#L89)* +*Defined in [codec/Option.ts:89](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Option.ts#L89)* **Returns:** `string` @@ -119,7 +119,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Option.ts:74](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Option.ts#L74)* +*Defined in [codec/Option.ts:74](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Option.ts#L74)* **Parameters:** @@ -136,7 +136,7 @@ ___ ▸ **decodeOption**<`O`>(Type: *`Constructor`<[Base](_codec_base_.base.md)<`O`>>*, value?: *`any`*): [Base](_codec_base_.base.md) -*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Option.ts#L26)* +*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Option.ts#L26)* **Type parameters:** @@ -157,7 +157,7 @@ ___ ▸ **with**<`O`>(Type: *`Constructor`<[Base](_codec_base_.base.md)<`O`>>*): `Constructor`<[Option](_codec_option_.option.md)<`O`>> -*Defined in [codec/Option.ts:42](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Option.ts#L42)* +*Defined in [codec/Option.ts:42](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Option.ts#L42)* **Type parameters:** diff --git a/docs/types/classes/_codec_set_.set.md b/docs/types/classes/_codec_set_.set.md index f68c8375d4..d231820a18 100644 --- a/docs/types/classes/_codec_set_.set.md +++ b/docs/types/classes/_codec_set_.set.md @@ -12,18 +12,18 @@ ## constructor -⊕ **new Set**(setValues: *`SetValues`*, value?: * [U8a](_codec_u8a_.u8a.md) | `Array`<`string`> | `Uint8Array` | `number`*): [Set](_codec_set_.set.md) +⊕ **new Set**(setValues: *`SetValues`*, value?: * `Array`<`string`> | `Uint8Array` | `number`*): [Set](_codec_set_.set.md) *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Set.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Set.ts#L19)* +*Defined in [codec/Set.ts:18](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Set.ts#L18)* **Parameters:** | Param | Type | | ------ | ------ | | setValues | `SetValues` | -| `Optional` value | [U8a](_codec_u8a_.u8a.md) | `Array`<`string`> | `Uint8Array` | `number`| +| `Optional` value | `Array`<`string`> | `Uint8Array` | `number`| **Returns:** [Set](_codec_set_.set.md) @@ -39,7 +39,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -53,7 +53,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Set.ts:68](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Set.ts#L68)* +*Defined in [codec/Set.ts:65](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Set.ts#L65)* **Returns:** `number` @@ -64,7 +64,7 @@ ___ getisEmpty(): `boolean` -*Defined in [codec/Set.ts:72](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Set.ts#L72)* +*Defined in [codec/Set.ts:69](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Set.ts#L69)* **Returns:** `boolean` @@ -75,7 +75,7 @@ ___ getvalueEncoded(): `number` -*Defined in [codec/Set.ts:80](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Set.ts#L80)* +*Defined in [codec/Set.ts:77](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Set.ts#L77)* **Returns:** `number` @@ -86,7 +86,7 @@ ___ getvalues(): `Array`<`string`> -*Defined in [codec/Set.ts:76](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Set.ts#L76)* +*Defined in [codec/Set.ts:73](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Set.ts#L73)* **Returns:** `Array`<`string`> @@ -102,7 +102,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Set.ts:84](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Set.ts#L84)* +*Defined in [codec/Set.ts:81](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Set.ts#L81)* **Returns:** `any` @@ -115,7 +115,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Set.ts:92](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Set.ts#L92)* +*Defined in [codec/Set.ts:89](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Set.ts#L89)* **Returns:** `string` @@ -128,7 +128,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Set.ts:88](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Set.ts#L88)* +*Defined in [codec/Set.ts:85](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Set.ts#L85)* **Parameters:** @@ -143,16 +143,16 @@ ___ ## `` decodeSet -▸ **decodeSet**(setValues: *`SetValues`*, value?: * [U8a](_codec_u8a_.u8a.md) | `Array`<`string`> | `Uint8Array` | `number`*): `Array`<`string`> +▸ **decodeSet**(setValues: *`SetValues`*, value?: * `Array`<`string`> | `Uint8Array` | `number`*): `Array`<`string`> -*Defined in [codec/Set.ts:29](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Set.ts#L29)* +*Defined in [codec/Set.ts:28](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Set.ts#L28)* **Parameters:** | Param | Type | Default value | | ------ | ------ | ------ | | setValues | `SetValues` | - | -| `Default value` value | [U8a](_codec_u8a_.u8a.md) | `Array`<`string`> | `Uint8Array` | `number`| 0 | +| `Default value` value | `Array`<`string`> | `Uint8Array` | `number`| 0 | **Returns:** `Array`<`string`> @@ -163,7 +163,7 @@ ___ ▸ **encodeSet**(setValues: *`SetValues`*, value: *`Array`<`string`>*): `number` -*Defined in [codec/Set.ts:62](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Set.ts#L62)* +*Defined in [codec/Set.ts:59](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Set.ts#L59)* **Parameters:** diff --git a/docs/types/classes/_codec_struct_.struct.md b/docs/types/classes/_codec_struct_.struct.md index 4cae3d8e0a..34560b3cbf 100644 --- a/docs/types/classes/_codec_struct_.struct.md +++ b/docs/types/classes/_codec_struct_.struct.md @@ -85,7 +85,7 @@ ⊕ **new Struct**(Types: *`S`*, value?: * `V` | `Array`<`any`>*, jsonMap?: *`Map`<`keyof S`, `string`>*): [Struct](_codec_struct_.struct.md) -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L28)* +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L27)* **Parameters:** @@ -118,7 +118,7 @@ ___ **● raw**: *`Map`<`keyof S`, [Base](_codec_base_.base.md)>* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -150,7 +150,7 @@ ___ getType(): `E` -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -161,7 +161,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -276,7 +276,7 @@ ___ ▸ **getAtIndex**(index: *`number`*): [Base](_codec_base_.base.md) -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -347,7 +347,7 @@ ___ ▸ **toArray**(): `Array`<[Base](_codec_base_.base.md)> -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -358,7 +358,7 @@ ___ ▸ **toHex**(): `string` -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -369,7 +369,7 @@ ___ ▸ **toJSON**(): `any` -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -380,7 +380,7 @@ ___ ▸ **toString**(): `string` -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -391,7 +391,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -423,7 +423,7 @@ ___ ▸ **with**<`S`>(Types: *`S`*): `Constructor`<[Struct](_codec_struct_.struct.md)<`S`>> -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_codec_tuple_.tuple.md b/docs/types/classes/_codec_tuple_.tuple.md index 9e7c9112a9..97ce478e9a 100644 --- a/docs/types/classes/_codec_tuple_.tuple.md +++ b/docs/types/classes/_codec_tuple_.tuple.md @@ -33,7 +33,7 @@ *Inherited from [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L28)* +*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L27)* **Parameters:** @@ -68,7 +68,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -93,7 +93,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -106,7 +106,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -223,7 +223,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -296,7 +296,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -309,7 +309,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -322,7 +322,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Tuple.ts#L28)* +*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Tuple.ts#L28)* **Returns:** `any` @@ -335,7 +335,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -348,7 +348,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -382,7 +382,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Tuple.ts#L18)* +*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Tuple.ts#L18)* **Type parameters:** diff --git a/docs/types/classes/_codec_u8a_.u8a.md b/docs/types/classes/_codec_u8a_.u8a.md index 2b474310e0..94f336437a 100644 --- a/docs/types/classes/_codec_u8a_.u8a.md +++ b/docs/types/classes/_codec_u8a_.u8a.md @@ -2,7 +2,7 @@ # Hierarchy - [Base](_codec_base_.base.md)<`Uint8Array`> + `Uint8Array` **↳ U8a** @@ -14,23 +14,30 @@ ↳ [Data](_data_.data.md) +# Implements + +* `Codec` + +# Indexable + +\[index: `number`\]: `number` # Constructors ## constructor -⊕ **new U8a**(value?: *`AnyU8a`*): [U8a](_codec_u8a_.u8a.md) +⊕ **new U8a**(value: * `AnyU8a` | `ArrayBuffer`*, byteOffset?: *`number`*, length?: * `undefined` | `number`*): [U8a](_codec_u8a_.u8a.md) -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L14)* +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* **Parameters:** | Param | Type | Default value | | ------ | ------ | ------ | -| `Default value` value | `AnyU8a` | new Uint8Array() | +| value | `AnyU8a` | `ArrayBuffer`| - | +| `Default value` byteOffset | `number` | 0 | +| `Optional` length | `undefined` | `number`| - | **Returns:** [U8a](_codec_u8a_.u8a.md) @@ -38,15 +45,98 @@ ___ # Properties + + +## BYTES_PER_ELEMENT + +**● BYTES_PER_ELEMENT**: *`number`* + +*Inherited from Uint8Array.BYTES_PER_ELEMENT* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1886* + +The size in bytes of each element in the array. + +___ + + +## __@toStringTag + +**● __@toStringTag**: *"UInt8Array"* + +*Inherited from Uint8Array.[Symbol.toStringTag]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* + +___ + + +## buffer + +**● buffer**: *`ArrayBufferLike`* + +*Inherited from Uint8Array.buffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1891* + +The ArrayBuffer instance referenced by the array. + +___ + + +## byteLength + +**● byteLength**: *`number`* + +*Inherited from Uint8Array.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1896* + +The length in bytes of the array. + +___ + + +## byteOffset + +**● byteOffset**: *`number`* + +*Inherited from Uint8Array.byteOffset* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1901* + +The offset in bytes of the array. + +___ + + +## length + +**● length**: *`number`* + +*Inherited from Uint8Array.length* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2000* + +The length of the array. + +___ ## raw **● raw**: *`Uint8Array`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +___ + + +## `` Uint8Array + +**● Uint8Array**: *`Uint8ArrayConstructor`* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2145* ___ @@ -58,20 +148,7 @@ ___ getencodedLength(): `number` -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/U8a.ts:35](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L35)* - -**Returns:** `number` - -___ - - -## length - -getlength(): `number` - -*Defined in [codec/U8a.ts:31](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L31)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L39)* **Returns:** `number` @@ -79,13 +156,557 @@ ___ # Methods + + +## __@iterator + +▸ **__@iterator**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.[Symbol.iterator]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* + +**Returns:** `IterableIterator`<`number`> + +___ + + +## copyWithin + +▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.copyWithin* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1912* + +Returns the this object after copying a section of the array identified by start and end to the same array starting at position target + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | +| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | +| `Optional` end | `undefined` | `number`| If not specified, length of the this object is used as its default value. | + +**Returns:** `this` + +___ + + +## entries + +▸ **entries**(): `IterableIterator`<[`number`, `number`]> + +*Inherited from Uint8Array.entries* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* + +Returns an array of key, value pairs for every entry in the array + +**Returns:** `IterableIterator`<[`number`, `number`]> + +___ + + +## every + +▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.every* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1922* + +Determines whether all the members of an array satisfy the specified test. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## fill + +▸ **fill**(value: *`number`*, start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.fill* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1932* + +Returns the this object after filling the section identified by start and end with value + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| value | `number` | value to fill array section with | +| `Optional` start | `undefined` | `number`| index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | +| `Optional` end | `undefined` | `number`| index to stop filling the array at. If end is negative, it is treated as length+end. | + +**Returns:** `this` + +___ + + +## filter + +▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.filter* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1941* + +Returns the elements of an array that meet the condition specified in a callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## find + +▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` | `undefined` + +*Inherited from Uint8Array.find* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1952* + +Returns the value of the first element in the array where predicate is true, and undefined otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` | `undefined` + +___ + + +## findIndex + +▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` + +*Inherited from Uint8Array.findIndex* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1963* + +Returns the index of the first element in the array where predicate is true, and -1 otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` + +___ + + +## forEach + +▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` + +*Inherited from Uint8Array.forEach* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* + +Performs the specified action for each element in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `void` + +___ + + +## includes + +▸ **includes**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `boolean` + +*Inherited from Uint8Array.includes* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* + +Determines whether an array includes a certain element, returning true or false as appropriate. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The element to search for. | +| `Optional` fromIndex | `undefined` | `number`| The position in this array at which to begin searching for searchElement. | + +**Returns:** `boolean` + +___ + + +## indexOf + +▸ **indexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.indexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1980* + +Returns the index of the first occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## join + +▸ **join**(separator?: * `undefined` | `string`*): `string` + +*Inherited from Uint8Array.join* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1987* + +Adds all the elements of an array separated by the specified separator string. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` separator | `undefined` | `string`| A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | + +**Returns:** `string` + +___ + + +## keys + +▸ **keys**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.keys* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* + +Returns an list of keys in the array + +**Returns:** `IterableIterator`<`number`> + +___ + + +## lastIndexOf + +▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.lastIndexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1995* + +Returns the index of the last occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## map + +▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.map* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2010* + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## reduce + +▸ **reduce**(callbackfn: *`function`*): `number` + +▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2022* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2023* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2035* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reduceRight + +▸ **reduceRight**(callbackfn: *`function`*): `number` + +▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2047* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2060* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reverse + +▸ **reverse**(): `Uint8Array` + +*Inherited from Uint8Array.reverse* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2065* + +Reverses the elements in an Array. + +**Returns:** `Uint8Array` + +___ + + +## set + +▸ **set**(array: *`ArrayLike`<`number`>*, offset?: * `undefined` | `number`*): `void` + +*Inherited from Uint8Array.set* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2072* + +Sets a value or an array of values. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | +| `Optional` offset | `undefined` | `number`| The index in the current array at which the values are to be written. | + +**Returns:** `void` + +___ + + +## slice + +▸ **slice**(start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.slice* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2079* + +Returns a section of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` start | `undefined` | `number`| The beginning of the specified portion of the array. | +| `Optional` end | `undefined` | `number`| The end of the specified portion of the array. | + +**Returns:** `Uint8Array` + +___ + + +## some + +▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.some* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2089* + +Determines whether the specified callback function returns true for any element of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## sort + +▸ **sort**(compareFn?: * `undefined` | `function`*): `this` + +*Inherited from Uint8Array.sort* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2096* + +Sorts an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` compareFn | `undefined` | `function`| The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | + +**Returns:** `this` + +___ + + +## subarray + +▸ **subarray**(begin: *`number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.subarray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2104* + +Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| begin | `number` | The index of the beginning of the array. | +| `Optional` end | `undefined` | `number`| The index of the end of the array. | + +**Returns:** `Uint8Array` + +___ ## toHex ▸ **toHex**(): `string` -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -96,12 +717,25 @@ ___ ▸ **toJSON**(): `any` -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` +___ + + +## toLocaleString + +▸ **toLocaleString**(): `string` + +*Inherited from Uint8Array.toLocaleString* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2109* + +Converts a number to a string by using the current locale. + +**Returns:** `string` + ___ @@ -109,9 +743,9 @@ ___ ▸ **toString**(): `string` -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -122,9 +756,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L51)* **Parameters:** @@ -135,21 +767,19 @@ ___ **Returns:** `Uint8Array` ___ - + -## `` decodeU8a +## values -▸ **decodeU8a**(value: *`any`*): `Uint8Array` +▸ **values**(): `IterableIterator`<`number`> -*Defined in [codec/U8a.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L21)* +*Inherited from Uint8Array.values* -**Parameters:** +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* -| Param | Type | -| ------ | ------ | -| value | `any` | +Returns an list of values in the array -**Returns:** `Uint8Array` +**Returns:** `IterableIterator`<`number`> ___ diff --git a/docs/types/classes/_codec_u8afixed_.u8afixed.md b/docs/types/classes/_codec_u8afixed_.u8afixed.md index fab83eb2ed..4c9f6a74d5 100644 --- a/docs/types/classes/_codec_u8afixed_.u8afixed.md +++ b/docs/types/classes/_codec_u8afixed_.u8afixed.md @@ -12,6 +12,13 @@ ↳ [AccountId](_accountid_.accountid.md) +# Implements + +* `Codec` + +# Indexable + +\[index: `number`\]: `number` # Constructors @@ -22,7 +29,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8aFixed.ts#L14)* +*Defined in [codec/U8aFixed.ts:15](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8aFixed.ts#L15)* **Parameters:** @@ -37,42 +44,116 @@ ___ # Properties - + -## raw +## BYTES_PER_ELEMENT -**● raw**: *`Uint8Array`* +**● BYTES_PER_ELEMENT**: *`number`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from Uint8Array.BYTES_PER_ELEMENT* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1886* + +The size in bytes of each element in the array. ___ + -# Accessors +## __@toStringTag - +**● __@toStringTag**: *"UInt8Array"* -## encodedLength +*Inherited from Uint8Array.[Symbol.toStringTag]* -getencodedLength(): `number` +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* -*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* +___ + -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8aFixed.ts#L32)* +## buffer -**Returns:** `number` +**● buffer**: *`ArrayBufferLike`* + +*Inherited from Uint8Array.buffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1891* + +The ArrayBuffer instance referenced by the array. + +___ + + +## byteLength + +**● byteLength**: *`number`* + +*Inherited from Uint8Array.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1896* + +The length in bytes of the array. + +___ + + +## byteOffset + +**● byteOffset**: *`number`* + +*Inherited from Uint8Array.byteOffset* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1901* + +The offset in bytes of the array. ___ ## length -getlength(): `number` +**● length**: *`number`* -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* +*Inherited from Uint8Array.length* -*Defined in [codec/U8a.ts:31](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L31)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2000* + +The length of the array. + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* + +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* + +___ + +# Accessors + + + +## bitLength + +getbitLength(): `number` + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + +___ + + +## encodedLength + +getencodedLength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* + +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L39)* **Returns:** `number` @@ -80,6 +161,550 @@ ___ # Methods + + +## __@iterator + +▸ **__@iterator**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.[Symbol.iterator]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* + +**Returns:** `IterableIterator`<`number`> + +___ + + +## copyWithin + +▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.copyWithin* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1912* + +Returns the this object after copying a section of the array identified by start and end to the same array starting at position target + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | +| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | +| `Optional` end | `undefined` | `number`| If not specified, length of the this object is used as its default value. | + +**Returns:** `this` + +___ + + +## entries + +▸ **entries**(): `IterableIterator`<[`number`, `number`]> + +*Inherited from Uint8Array.entries* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* + +Returns an array of key, value pairs for every entry in the array + +**Returns:** `IterableIterator`<[`number`, `number`]> + +___ + + +## every + +▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.every* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1922* + +Determines whether all the members of an array satisfy the specified test. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## fill + +▸ **fill**(value: *`number`*, start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.fill* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1932* + +Returns the this object after filling the section identified by start and end with value + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| value | `number` | value to fill array section with | +| `Optional` start | `undefined` | `number`| index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | +| `Optional` end | `undefined` | `number`| index to stop filling the array at. If end is negative, it is treated as length+end. | + +**Returns:** `this` + +___ + + +## filter + +▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.filter* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1941* + +Returns the elements of an array that meet the condition specified in a callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## find + +▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` | `undefined` + +*Inherited from Uint8Array.find* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1952* + +Returns the value of the first element in the array where predicate is true, and undefined otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` | `undefined` + +___ + + +## findIndex + +▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` + +*Inherited from Uint8Array.findIndex* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1963* + +Returns the index of the first element in the array where predicate is true, and -1 otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` + +___ + + +## forEach + +▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` + +*Inherited from Uint8Array.forEach* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* + +Performs the specified action for each element in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `void` + +___ + + +## includes + +▸ **includes**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `boolean` + +*Inherited from Uint8Array.includes* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* + +Determines whether an array includes a certain element, returning true or false as appropriate. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The element to search for. | +| `Optional` fromIndex | `undefined` | `number`| The position in this array at which to begin searching for searchElement. | + +**Returns:** `boolean` + +___ + + +## indexOf + +▸ **indexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.indexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1980* + +Returns the index of the first occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## join + +▸ **join**(separator?: * `undefined` | `string`*): `string` + +*Inherited from Uint8Array.join* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1987* + +Adds all the elements of an array separated by the specified separator string. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` separator | `undefined` | `string`| A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | + +**Returns:** `string` + +___ + + +## keys + +▸ **keys**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.keys* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* + +Returns an list of keys in the array + +**Returns:** `IterableIterator`<`number`> + +___ + + +## lastIndexOf + +▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.lastIndexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1995* + +Returns the index of the last occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## map + +▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.map* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2010* + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## reduce + +▸ **reduce**(callbackfn: *`function`*): `number` + +▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2022* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2023* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2035* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reduceRight + +▸ **reduceRight**(callbackfn: *`function`*): `number` + +▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2047* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2060* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reverse + +▸ **reverse**(): `Uint8Array` + +*Inherited from Uint8Array.reverse* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2065* + +Reverses the elements in an Array. + +**Returns:** `Uint8Array` + +___ + + +## set + +▸ **set**(array: *`ArrayLike`<`number`>*, offset?: * `undefined` | `number`*): `void` + +*Inherited from Uint8Array.set* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2072* + +Sets a value or an array of values. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | +| `Optional` offset | `undefined` | `number`| The index in the current array at which the values are to be written. | + +**Returns:** `void` + +___ + + +## slice + +▸ **slice**(start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.slice* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2079* + +Returns a section of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` start | `undefined` | `number`| The beginning of the specified portion of the array. | +| `Optional` end | `undefined` | `number`| The end of the specified portion of the array. | + +**Returns:** `Uint8Array` + +___ + + +## some + +▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.some* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2089* + +Determines whether the specified callback function returns true for any element of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## sort + +▸ **sort**(compareFn?: * `undefined` | `function`*): `this` + +*Inherited from Uint8Array.sort* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2096* + +Sorts an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` compareFn | `undefined` | `function`| The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | + +**Returns:** `this` + +___ + + +## subarray + +▸ **subarray**(begin: *`number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.subarray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2104* + +Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| begin | `number` | The index of the beginning of the array. | +| `Optional` end | `undefined` | `number`| The index of the end of the array. | + +**Returns:** `Uint8Array` + +___ ## toHex @@ -88,7 +713,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -101,12 +726,25 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` +___ + + +## toLocaleString + +▸ **toLocaleString**(): `string` + +*Inherited from Uint8Array.toLocaleString* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2109* + +Converts a number to a string by using the current locale. + +**Returns:** `string` + ___ @@ -116,9 +754,9 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -131,9 +769,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L51)* **Parameters:** @@ -144,23 +780,19 @@ ___ **Returns:** `Uint8Array` ___ - + -## `` decodeU8a +## values -▸ **decodeU8a**(value: *`any`*): `Uint8Array` +▸ **values**(): `IterableIterator`<`number`> -*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)* +*Inherited from Uint8Array.values* -*Defined in [codec/U8a.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L21)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* -**Parameters:** +Returns an list of values in the array -| Param | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** `Uint8Array` +**Returns:** `IterableIterator`<`number`> ___ diff --git a/docs/types/classes/_codec_uint_.uint.md b/docs/types/classes/_codec_uint_.uint.md index d179f71b86..6244102b0c 100644 --- a/docs/types/classes/_codec_uint_.uint.md +++ b/docs/types/classes/_codec_uint_.uint.md @@ -28,7 +28,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/UInt.ts:25](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L25)* +*Defined in [codec/UInt.ts:24](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L24)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -64,7 +64,7 @@ ___ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -77,7 +77,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -91,7 +91,7 @@ ___ ▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -108,7 +108,7 @@ ___ ▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -125,7 +125,7 @@ ___ ▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -142,7 +142,7 @@ ___ ▸ **eq**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -159,7 +159,7 @@ ___ ▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -176,7 +176,7 @@ ___ ▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -193,7 +193,7 @@ ___ ▸ **isZero**(): `boolean` -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -204,7 +204,7 @@ ___ ▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -221,7 +221,7 @@ ___ ▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -238,7 +238,7 @@ ___ ▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -255,7 +255,7 @@ ___ ▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -272,7 +272,7 @@ ___ ▸ **toBn**(): `BN` -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -283,7 +283,7 @@ ___ ▸ **toHex**(): `string` -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -296,7 +296,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -307,7 +307,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -320,7 +320,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -333,7 +333,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -350,7 +350,7 @@ ___ ▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `BN` -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_codec_vector_.vector.md b/docs/types/classes/_codec_vector_.vector.md index a5590026d4..45199c77dd 100644 --- a/docs/types/classes/_codec_vector_.vector.md +++ b/docs/types/classes/_codec_vector_.vector.md @@ -18,18 +18,18 @@ ## constructor -⊕ **new Vector**(Type: *`Constructor`<`T`>*, value?: * [Vector](_codec_vector_.vector.md)<`any`> | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `string` | `Array`<`any`>*): [Vector](_codec_vector_.vector.md) +⊕ **new Vector**(Type: *`Constructor`<`T`>*, value?: * [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>*): [Vector](_codec_vector_.vector.md) *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Vector.ts:20](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L20)* +*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L19)* **Parameters:** | Param | Type | Default value | | ------ | ------ | ------ | | Type | `Constructor`<`T`> | - | -| `Default value` value | [Vector](_codec_vector_.vector.md)<`any`> | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `string` | `Array`<`any`>| [] as Array<any> | +| `Default value` value | [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>| [] as Array<any> | **Returns:** [Vector](_codec_vector_.vector.md) @@ -45,7 +45,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -57,7 +57,7 @@ ___ getType(): `string` -*Defined in [codec/Vector.ts:68](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L68)* +*Defined in [codec/Vector.ts:65](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L65)* **Returns:** `string` @@ -70,7 +70,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Vector.ts:76](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L76)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L73)* **Returns:** `number` @@ -81,7 +81,7 @@ ___ getlength(): `number` -*Defined in [codec/Vector.ts:72](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L72)* +*Defined in [codec/Vector.ts:69](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L69)* **Returns:** `number` @@ -95,7 +95,7 @@ ___ ▸ **filter**(fn: *`function`*): `Array`<`T`> -*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L82)* +*Defined in [codec/Vector.ts:79](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L79)* **Parameters:** @@ -112,7 +112,7 @@ ___ ▸ **find**(fn: *`function`*): `T` | `undefined` -*Defined in [codec/Vector.ts:86](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L86)* +*Defined in [codec/Vector.ts:83](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L83)* **Parameters:** @@ -129,7 +129,7 @@ ___ ▸ **forEach**(fn: *`function`*): `any` -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L90)* +*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L87)* **Parameters:** @@ -146,7 +146,7 @@ ___ ▸ **get**(index: *`number`*): `T` -*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L94)* +*Defined in [codec/Vector.ts:91](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L91)* **Parameters:** @@ -163,7 +163,7 @@ ___ ▸ **map**<`O`>(fn: *`function`*): `Array`<`O`> -*Defined in [codec/Vector.ts:98](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L98)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L95)* **Type parameters:** @@ -183,7 +183,7 @@ ___ ▸ **push**(item: *`T`*): `void` -*Defined in [codec/Vector.ts:102](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L102)* +*Defined in [codec/Vector.ts:99](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L99)* **Parameters:** @@ -200,7 +200,7 @@ ___ ▸ **reduce**<`O`>(fn: *`function`*, initial: *`O`*): `O` -*Defined in [codec/Vector.ts:106](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L106)* +*Defined in [codec/Vector.ts:103](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L103)* **Type parameters:** @@ -223,7 +223,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L110)* +*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L107)* **Returns:** `any` @@ -236,7 +236,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L129)* +*Defined in [codec/Vector.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L126)* **Returns:** `string` @@ -249,7 +249,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Vector.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L116)* +*Defined in [codec/Vector.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L113)* **Parameters:** @@ -264,9 +264,9 @@ ___ ## `` decodeVector -▸ **decodeVector**<`T`>(Type: *`Constructor`<`T`>*, value: * [Vector](_codec_vector_.vector.md)<`any`> | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `string` | `Array`<`any`>*): `Array`<`T`> +▸ **decodeVector**<`T`>(Type: *`Constructor`<`T`>*, value: * [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>*): `Array`<`T`> -*Defined in [codec/Vector.ts:30](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L30)* +*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L29)* **Type parameters:** @@ -276,7 +276,7 @@ ___ | Param | Type | | ------ | ------ | | Type | `Constructor`<`T`> | -| value | [Vector](_codec_vector_.vector.md)<`any`> | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `string` | `Array`<`any`>| +| value | [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>| **Returns:** `Array`<`T`> @@ -287,7 +287,7 @@ ___ ▸ **with**<`O`>(Type: *`Constructor`<`O`>*): `Constructor`<[Vector](_codec_vector_.vector.md)<`O`>> -*Defined in [codec/Vector.ts:60](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L60)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L57)* **Type parameters:** diff --git a/docs/types/classes/_data_.data.md b/docs/types/classes/_data_.data.md index c427a4acc3..8c4f4e3d02 100644 --- a/docs/types/classes/_data_.data.md +++ b/docs/types/classes/_data_.data.md @@ -6,25 +6,32 @@ **↳ Data** +# Implements + +* `Codec` + +# Indexable + +\[index: `number`\]: `number` # Constructors ## constructor -⊕ **new Data**(value?: *`AnyU8a`*): [Data](_data_.data.md) +⊕ **new Data**(value: * `AnyU8a` | `ArrayBuffer`*, byteOffset?: *`number`*, length?: * `undefined` | `number`*): [Data](_data_.data.md) *Inherited from [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L14)* +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* **Parameters:** | Param | Type | Default value | | ------ | ------ | ------ | -| `Default value` value | `AnyU8a` | new Uint8Array() | +| value | `AnyU8a` | `ArrayBuffer`| - | +| `Default value` byteOffset | `number` | 0 | +| `Optional` length | `undefined` | `number`| - | **Returns:** [Data](_data_.data.md) @@ -32,15 +39,91 @@ ___ # Properties + + +## BYTES_PER_ELEMENT + +**● BYTES_PER_ELEMENT**: *`number`* + +*Inherited from Uint8Array.BYTES_PER_ELEMENT* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1886* + +The size in bytes of each element in the array. + +___ + + +## __@toStringTag + +**● __@toStringTag**: *"UInt8Array"* + +*Inherited from Uint8Array.[Symbol.toStringTag]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* + +___ + + +## buffer + +**● buffer**: *`ArrayBufferLike`* + +*Inherited from Uint8Array.buffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1891* + +The ArrayBuffer instance referenced by the array. + +___ + + +## byteLength + +**● byteLength**: *`number`* + +*Inherited from Uint8Array.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1896* + +The length in bytes of the array. + +___ + + +## byteOffset + +**● byteOffset**: *`number`* + +*Inherited from Uint8Array.byteOffset* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1901* + +The offset in bytes of the array. + +___ + + +## length + +**● length**: *`number`* + +*Inherited from Uint8Array.length* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2000* + +The length of the array. + +___ ## raw **● raw**: *`Uint8Array`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* ___ @@ -54,22 +137,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/U8a.ts:35](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L35)* - -**Returns:** `number` - -___ - - -## length - -getlength(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [codec/U8a.ts:31](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L31)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L39)* **Returns:** `number` @@ -77,6 +145,550 @@ ___ # Methods + + +## __@iterator + +▸ **__@iterator**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.[Symbol.iterator]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* + +**Returns:** `IterableIterator`<`number`> + +___ + + +## copyWithin + +▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.copyWithin* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1912* + +Returns the this object after copying a section of the array identified by start and end to the same array starting at position target + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | +| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | +| `Optional` end | `undefined` | `number`| If not specified, length of the this object is used as its default value. | + +**Returns:** `this` + +___ + + +## entries + +▸ **entries**(): `IterableIterator`<[`number`, `number`]> + +*Inherited from Uint8Array.entries* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* + +Returns an array of key, value pairs for every entry in the array + +**Returns:** `IterableIterator`<[`number`, `number`]> + +___ + + +## every + +▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.every* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1922* + +Determines whether all the members of an array satisfy the specified test. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## fill + +▸ **fill**(value: *`number`*, start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.fill* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1932* + +Returns the this object after filling the section identified by start and end with value + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| value | `number` | value to fill array section with | +| `Optional` start | `undefined` | `number`| index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | +| `Optional` end | `undefined` | `number`| index to stop filling the array at. If end is negative, it is treated as length+end. | + +**Returns:** `this` + +___ + + +## filter + +▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.filter* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1941* + +Returns the elements of an array that meet the condition specified in a callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## find + +▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` | `undefined` + +*Inherited from Uint8Array.find* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1952* + +Returns the value of the first element in the array where predicate is true, and undefined otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` | `undefined` + +___ + + +## findIndex + +▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` + +*Inherited from Uint8Array.findIndex* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1963* + +Returns the index of the first element in the array where predicate is true, and -1 otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` + +___ + + +## forEach + +▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` + +*Inherited from Uint8Array.forEach* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* + +Performs the specified action for each element in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `void` + +___ + + +## includes + +▸ **includes**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `boolean` + +*Inherited from Uint8Array.includes* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* + +Determines whether an array includes a certain element, returning true or false as appropriate. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The element to search for. | +| `Optional` fromIndex | `undefined` | `number`| The position in this array at which to begin searching for searchElement. | + +**Returns:** `boolean` + +___ + + +## indexOf + +▸ **indexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.indexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1980* + +Returns the index of the first occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## join + +▸ **join**(separator?: * `undefined` | `string`*): `string` + +*Inherited from Uint8Array.join* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1987* + +Adds all the elements of an array separated by the specified separator string. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` separator | `undefined` | `string`| A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | + +**Returns:** `string` + +___ + + +## keys + +▸ **keys**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.keys* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* + +Returns an list of keys in the array + +**Returns:** `IterableIterator`<`number`> + +___ + + +## lastIndexOf + +▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.lastIndexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1995* + +Returns the index of the last occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## map + +▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.map* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2010* + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## reduce + +▸ **reduce**(callbackfn: *`function`*): `number` + +▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2022* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2023* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2035* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reduceRight + +▸ **reduceRight**(callbackfn: *`function`*): `number` + +▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2047* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2060* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reverse + +▸ **reverse**(): `Uint8Array` + +*Inherited from Uint8Array.reverse* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2065* + +Reverses the elements in an Array. + +**Returns:** `Uint8Array` + +___ + + +## set + +▸ **set**(array: *`ArrayLike`<`number`>*, offset?: * `undefined` | `number`*): `void` + +*Inherited from Uint8Array.set* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2072* + +Sets a value or an array of values. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | +| `Optional` offset | `undefined` | `number`| The index in the current array at which the values are to be written. | + +**Returns:** `void` + +___ + + +## slice + +▸ **slice**(start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.slice* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2079* + +Returns a section of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` start | `undefined` | `number`| The beginning of the specified portion of the array. | +| `Optional` end | `undefined` | `number`| The end of the specified portion of the array. | + +**Returns:** `Uint8Array` + +___ + + +## some + +▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.some* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2089* + +Determines whether the specified callback function returns true for any element of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## sort + +▸ **sort**(compareFn?: * `undefined` | `function`*): `this` + +*Inherited from Uint8Array.sort* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2096* + +Sorts an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` compareFn | `undefined` | `function`| The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | + +**Returns:** `this` + +___ + + +## subarray + +▸ **subarray**(begin: *`number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.subarray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2104* + +Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| begin | `number` | The index of the beginning of the array. | +| `Optional` end | `undefined` | `number`| The index of the end of the array. | + +**Returns:** `Uint8Array` + +___ ## toHex @@ -85,7 +697,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -98,12 +710,25 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` +___ + + +## toLocaleString + +▸ **toLocaleString**(): `string` + +*Inherited from Uint8Array.toLocaleString* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2109* + +Converts a number to a string by using the current locale. + +**Returns:** `string` + ___ @@ -113,9 +738,9 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -128,9 +753,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L51)* **Parameters:** @@ -141,23 +764,19 @@ ___ **Returns:** `Uint8Array` ___ - + -## `` decodeU8a +## values -▸ **decodeU8a**(value: *`any`*): `Uint8Array` +▸ **values**(): `IterableIterator`<`number`> -*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)* +*Inherited from Uint8Array.values* -*Defined in [codec/U8a.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L21)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* -**Parameters:** +Returns an list of values in the array -| Param | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** `Uint8Array` +**Returns:** `IterableIterator`<`number`> ___ diff --git a/docs/types/classes/_digest_.digest.md b/docs/types/classes/_digest_.digest.md index 9ac0111c09..3a816c17ca 100644 --- a/docs/types/classes/_digest_.digest.md +++ b/docs/types/classes/_digest_.digest.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Digest.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Digest.ts#L53)* +*Defined in [Digest.ts:53](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Digest.ts#L53)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getlogs(): [Vector](_codec_vector_.vector.md)<[DigestItem](_digest_.digestitem.md)> -*Defined in [Digest.ts:60](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Digest.ts#L60)* +*Defined in [Digest.ts:60](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Digest.ts#L60)* **Returns:** [Vector](_codec_vector_.vector.md)<[DigestItem](_digest_.digestitem.md)> @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -297,7 +297,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -310,7 +310,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -323,7 +323,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -336,7 +336,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -383,7 +383,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_digest_.digestitem.md b/docs/types/classes/_digest_.digestitem.md index 7818c147e0..5920d29b16 100644 --- a/docs/types/classes/_digest_.digestitem.md +++ b/docs/types/classes/_digest_.digestitem.md @@ -16,7 +16,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [Digest.ts:42](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Digest.ts#L42)* +*Defined in [Digest.ts:42](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Digest.ts#L42)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L97)* +*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L94)* **Returns:** `number` @@ -67,7 +67,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:85](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L85)* +*Defined in [codec/EnumType.ts:82](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L82)* **Returns:** `boolean` @@ -80,7 +80,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L89)* +*Defined in [codec/EnumType.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L86)* **Returns:** `string` @@ -93,7 +93,7 @@ getvalue(): [Base](_codec_base_.base.md)< `AuthoritiesChange` | `ChangesTri *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:93](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L93)* +*Defined in [codec/EnumType.ts:90](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L90)* **Returns:** [Base](_codec_base_.base.md)< `AuthoritiesChange` | `ChangesTrieRoot` | `Other` | `Seal`> @@ -109,7 +109,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[setValue](_codec_enumtype_.enumtype.md#setvalue)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L98)* **Parameters:** @@ -131,7 +131,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L118)* +*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L115)* **Returns:** `any` @@ -144,7 +144,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:122](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L122)* +*Defined in [codec/EnumType.ts:119](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L119)* **Returns:** `number` @@ -159,7 +159,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/EnumType.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L126)* +*Defined in [codec/EnumType.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L123)* **Returns:** `string` @@ -174,7 +174,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/EnumType.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L130)* +*Defined in [codec/EnumType.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L127)* **Parameters:** @@ -193,7 +193,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[decodeEnumType](_codec_enumtype_.enumtype.md#decodeenumtype)* -*Defined in [codec/EnumType.ts:46](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L46)* +*Defined in [codec/EnumType.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L45)* **Type parameters:** diff --git a/docs/types/classes/_event_.event.md b/docs/types/classes/_event_.event.md index f7304b1ac7..5c626a3501 100644 --- a/docs/types/classes/_event_.event.md +++ b/docs/types/classes/_event_.event.md @@ -21,17 +21,17 @@ ## constructor -⊕ **new Event**(_value: * `Uint8Array` | [U8a](_codec_u8a_.u8a.md)*): [Event](_event_.event.md) +⊕ **new Event**(_value: *`Uint8Array`*): [Event](_event_.event.md) *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Event.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Event.ts#L57)* +*Defined in [Event.ts:56](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Event.ts#L56)* **Parameters:** | Param | Type | | ------ | ------ | -| _value | `Uint8Array` | [U8a](_codec_u8a_.u8a.md)| +| _value | `Uint8Array` | **Returns:** [Event](_event_.event.md) @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getdata(): `EventData` -*Defined in [Event.ts:114](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Event.ts#L114)* +*Defined in [Event.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Event.ts#L110)* **Returns:** `EventData` @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getindex(): `EventIndex` -*Defined in [Event.ts:118](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Event.ts#L118)* +*Defined in [Event.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Event.ts#L114)* **Returns:** `EventIndex` @@ -129,7 +129,7 @@ ___ getmeta(): [EventMetadata](_metadata_.eventmetadata.md) -*Defined in [Event.ts:122](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Event.ts#L122)* +*Defined in [Event.ts:118](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Event.ts#L118)* **Returns:** [EventMetadata](_metadata_.eventmetadata.md) @@ -140,7 +140,7 @@ ___ getmethod(): `string` -*Defined in [Event.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Event.ts#L126)* +*Defined in [Event.ts:122](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Event.ts#L122)* **Returns:** `string` @@ -151,7 +151,7 @@ ___ getsection(): `string` -*Defined in [Event.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Event.ts#L130)* +*Defined in [Event.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Event.ts#L126)* **Returns:** `string` @@ -162,7 +162,7 @@ ___ gettypeDef(): `Array`<[TypeDef](../modules/_codec_createtype_.md#typedef)> -*Defined in [Event.ts:134](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Event.ts#L134)* +*Defined in [Event.ts:130](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Event.ts#L130)* **Returns:** `Array`<[TypeDef](../modules/_codec_createtype_.md#typedef)> @@ -279,7 +279,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -352,7 +352,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -365,7 +365,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -378,7 +378,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -391,7 +391,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -404,7 +404,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -434,15 +434,15 @@ ___ ## `` decodeEvent -▸ **decodeEvent**(_value: * [U8a](_codec_u8a_.u8a.md) | `Uint8Array`*): `object` +▸ **decodeEvent**(value: *`Uint8Array`*): `object` -*Defined in [Event.ts:69](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Event.ts#L69)* +*Defined in [Event.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Event.ts#L68)* **Parameters:** | Param | Type | | ------ | ------ | -| _value | [U8a](_codec_u8a_.u8a.md) | `Uint8Array`| +| value | `Uint8Array` | **Returns:** `object` @@ -453,7 +453,7 @@ ___ ▸ **injectMetadata**(metadata: *`Metadata`*): `void` -*Defined in [Event.ts:91](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Event.ts#L91)* +*Defined in [Event.ts:87](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Event.ts#L87)* **Parameters:** @@ -472,7 +472,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_eventrecord_.eventrecord.md b/docs/types/classes/_eventrecord_.eventrecord.md index 1abd6ef445..59deb5dca5 100644 --- a/docs/types/classes/_eventrecord_.eventrecord.md +++ b/docs/types/classes/_eventrecord_.eventrecord.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [EventRecord.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/EventRecord.ts#L26)* +*Defined in [EventRecord.ts:26](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/EventRecord.ts#L26)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getevent(): [Event](_event_.event.md) -*Defined in [EventRecord.ts:34](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/EventRecord.ts#L34)* +*Defined in [EventRecord.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/EventRecord.ts#L34)* **Returns:** [Event](_event_.event.md) @@ -118,7 +118,7 @@ ___ getphase(): `Phase` -*Defined in [EventRecord.ts:38](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/EventRecord.ts#L38)* +*Defined in [EventRecord.ts:38](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/EventRecord.ts#L38)* **Returns:** `Phase` @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_extrinsic_.extrinsic.md b/docs/types/classes/_extrinsic_.extrinsic.md index 3299eac258..7073ac91c9 100644 --- a/docs/types/classes/_extrinsic_.extrinsic.md +++ b/docs/types/classes/_extrinsic_.extrinsic.md @@ -34,7 +34,7 @@ Can be: *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Extrinsic.ts:35](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L35)* +*Defined in [Extrinsic.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L34)* **Parameters:** @@ -67,7 +67,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -92,7 +92,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -103,7 +103,7 @@ ___ getargs(): `Array`<[Base](_codec_base_.base.md)> -*Defined in [Extrinsic.ts:73](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L73)* +*Defined in [Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L70)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -114,7 +114,7 @@ ___ getcallIndex(): `Uint8Array` -*Defined in [Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L78)* +*Defined in [Extrinsic.ts:75](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L75)* **Returns:** `Uint8Array` @@ -125,7 +125,7 @@ ___ getdata(): `Uint8Array` -*Defined in [Extrinsic.ts:82](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L82)* +*Defined in [Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L79)* **Returns:** `Uint8Array` @@ -138,7 +138,7 @@ getencodedLength(): `number` *Overrides [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [Extrinsic.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L113)* +*Defined in [Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L110)* **Returns:** `number` @@ -149,7 +149,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Extrinsic.ts:87](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L87)* +*Defined in [Extrinsic.ts:84](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L84)* **Returns:** [Hash](_hash_.hash.md) @@ -160,7 +160,7 @@ ___ getisSigned(): `boolean` -*Defined in [Extrinsic.ts:93](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L93)* +*Defined in [Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L90)* **Returns:** `boolean` @@ -171,7 +171,7 @@ ___ getlength(): `number` -*Defined in [Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L97)* +*Defined in [Extrinsic.ts:94](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L94)* **Returns:** `number` @@ -182,7 +182,7 @@ ___ getmeta(): [FunctionMetadata](_metadata_.functionmetadata.md) -*Defined in [Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L101)* +*Defined in [Extrinsic.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L98)* **Returns:** [FunctionMetadata](_metadata_.functionmetadata.md) @@ -193,7 +193,7 @@ ___ getmethod(): [Method](_method_.method.md) -*Defined in [Extrinsic.ts:105](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L105)* +*Defined in [Extrinsic.ts:102](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L102)* **Returns:** [Method](_method_.method.md) @@ -204,7 +204,7 @@ ___ getsignature(): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) -*Defined in [Extrinsic.ts:109](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L109)* +*Defined in [Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L106)* **Returns:** [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -392,7 +392,7 @@ ___ ▸ **sign**(signerPair: *`KeyringPair`*, nonce: *`AnyNumber`*, blockHash: *`AnyU8a`*): [Extrinsic](_extrinsic_.extrinsic.md) -*Defined in [Extrinsic.ts:119](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L119)* +*Defined in [Extrinsic.ts:116](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L116)* **Parameters:** @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -426,7 +426,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L136)* +*Defined in [Extrinsic.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L133)* **Returns:** `string` @@ -439,7 +439,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [Extrinsic.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L140)* +*Defined in [Extrinsic.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L137)* **Returns:** `any` @@ -452,7 +452,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -465,7 +465,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [Extrinsic.ts:125](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L125)* +*Defined in [Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L122)* **Parameters:** @@ -497,7 +497,7 @@ ___ ▸ **decodeExtrinsic**(value?: * `ExtrinsicValue` | `AnyU8a`*): `any` | `Uint8Array` -*Defined in [Extrinsic.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Extrinsic.ts#L43)* +*Defined in [Extrinsic.ts:42](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Extrinsic.ts#L42)* **Parameters:** @@ -516,7 +516,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicera_.extrinsicera.md b/docs/types/classes/_extrinsicera_.extrinsicera.md index 85748e7ba0..ed729fa96b 100644 --- a/docs/types/classes/_extrinsicera_.extrinsicera.md +++ b/docs/types/classes/_extrinsicera_.extrinsicera.md @@ -6,6 +6,13 @@ **↳ ExtrinsicEra** +# Implements + +* `Codec` + +# Indexable + +\[index: `number`\]: `number` # Constructors @@ -16,7 +23,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [ExtrinsicEra.ts:11](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ExtrinsicEra.ts#L11)* +*Defined in [ExtrinsicEra.ts:11](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ExtrinsicEra.ts#L11)* **Parameters:** @@ -30,15 +37,91 @@ ___ # Properties + + +## BYTES_PER_ELEMENT + +**● BYTES_PER_ELEMENT**: *`number`* + +*Inherited from Uint8Array.BYTES_PER_ELEMENT* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1886* + +The size in bytes of each element in the array. + +___ + + +## __@toStringTag + +**● __@toStringTag**: *"UInt8Array"* + +*Inherited from Uint8Array.[Symbol.toStringTag]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* + +___ + + +## buffer + +**● buffer**: *`ArrayBufferLike`* + +*Inherited from Uint8Array.buffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1891* + +The ArrayBuffer instance referenced by the array. + +___ + + +## byteLength + +**● byteLength**: *`number`* + +*Inherited from Uint8Array.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1896* + +The length in bytes of the array. + +___ + + +## byteOffset + +**● byteOffset**: *`number`* + +*Inherited from Uint8Array.byteOffset* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1901* + +The offset in bytes of the array. + +___ + + +## length + +**● length**: *`number`* + +*Inherited from Uint8Array.length* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2000* + +The length of the array. + +___ ## raw **● raw**: *`Uint8Array`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* ___ @@ -52,22 +135,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* - -*Defined in [codec/U8a.ts:35](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L35)* - -**Returns:** `number` - -___ - - -## length - -getlength(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [codec/U8a.ts:31](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L31)* +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L39)* **Returns:** `number` @@ -75,6 +143,550 @@ ___ # Methods + + +## __@iterator + +▸ **__@iterator**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.[Symbol.iterator]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* + +**Returns:** `IterableIterator`<`number`> + +___ + + +## copyWithin + +▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.copyWithin* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1912* + +Returns the this object after copying a section of the array identified by start and end to the same array starting at position target + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | +| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | +| `Optional` end | `undefined` | `number`| If not specified, length of the this object is used as its default value. | + +**Returns:** `this` + +___ + + +## entries + +▸ **entries**(): `IterableIterator`<[`number`, `number`]> + +*Inherited from Uint8Array.entries* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* + +Returns an array of key, value pairs for every entry in the array + +**Returns:** `IterableIterator`<[`number`, `number`]> + +___ + + +## every + +▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.every* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1922* + +Determines whether all the members of an array satisfy the specified test. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## fill + +▸ **fill**(value: *`number`*, start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.fill* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1932* + +Returns the this object after filling the section identified by start and end with value + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| value | `number` | value to fill array section with | +| `Optional` start | `undefined` | `number`| index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | +| `Optional` end | `undefined` | `number`| index to stop filling the array at. If end is negative, it is treated as length+end. | + +**Returns:** `this` + +___ + + +## filter + +▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.filter* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1941* + +Returns the elements of an array that meet the condition specified in a callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## find + +▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` | `undefined` + +*Inherited from Uint8Array.find* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1952* + +Returns the value of the first element in the array where predicate is true, and undefined otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` | `undefined` + +___ + + +## findIndex + +▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` + +*Inherited from Uint8Array.findIndex* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1963* + +Returns the index of the first element in the array where predicate is true, and -1 otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` + +___ + + +## forEach + +▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` + +*Inherited from Uint8Array.forEach* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* + +Performs the specified action for each element in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `void` + +___ + + +## includes + +▸ **includes**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `boolean` + +*Inherited from Uint8Array.includes* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* + +Determines whether an array includes a certain element, returning true or false as appropriate. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The element to search for. | +| `Optional` fromIndex | `undefined` | `number`| The position in this array at which to begin searching for searchElement. | + +**Returns:** `boolean` + +___ + + +## indexOf + +▸ **indexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.indexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1980* + +Returns the index of the first occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## join + +▸ **join**(separator?: * `undefined` | `string`*): `string` + +*Inherited from Uint8Array.join* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1987* + +Adds all the elements of an array separated by the specified separator string. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` separator | `undefined` | `string`| A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | + +**Returns:** `string` + +___ + + +## keys + +▸ **keys**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.keys* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* + +Returns an list of keys in the array + +**Returns:** `IterableIterator`<`number`> + +___ + + +## lastIndexOf + +▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.lastIndexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1995* + +Returns the index of the last occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## map + +▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.map* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2010* + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## reduce + +▸ **reduce**(callbackfn: *`function`*): `number` + +▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2022* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2023* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2035* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reduceRight + +▸ **reduceRight**(callbackfn: *`function`*): `number` + +▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2047* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2060* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reverse + +▸ **reverse**(): `Uint8Array` + +*Inherited from Uint8Array.reverse* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2065* + +Reverses the elements in an Array. + +**Returns:** `Uint8Array` + +___ + + +## set + +▸ **set**(array: *`ArrayLike`<`number`>*, offset?: * `undefined` | `number`*): `void` + +*Inherited from Uint8Array.set* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2072* + +Sets a value or an array of values. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | +| `Optional` offset | `undefined` | `number`| The index in the current array at which the values are to be written. | + +**Returns:** `void` + +___ + + +## slice + +▸ **slice**(start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.slice* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2079* + +Returns a section of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` start | `undefined` | `number`| The beginning of the specified portion of the array. | +| `Optional` end | `undefined` | `number`| The end of the specified portion of the array. | + +**Returns:** `Uint8Array` + +___ + + +## some + +▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.some* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2089* + +Determines whether the specified callback function returns true for any element of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## sort + +▸ **sort**(compareFn?: * `undefined` | `function`*): `this` + +*Inherited from Uint8Array.sort* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2096* + +Sorts an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` compareFn | `undefined` | `function`| The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | + +**Returns:** `this` + +___ + + +## subarray + +▸ **subarray**(begin: *`number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.subarray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2104* + +Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| begin | `number` | The index of the beginning of the array. | +| `Optional` end | `undefined` | `number`| The index of the end of the array. | + +**Returns:** `Uint8Array` + +___ ## toHex @@ -83,7 +695,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -96,12 +708,25 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` +___ + + +## toLocaleString + +▸ **toLocaleString**(): `string` + +*Inherited from Uint8Array.toLocaleString* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2109* + +Converts a number to a string by using the current locale. + +**Returns:** `string` + ___ @@ -111,9 +736,9 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -126,9 +751,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L51)* **Parameters:** @@ -138,6 +761,21 @@ ___ **Returns:** `Uint8Array` +___ + + +## values + +▸ **values**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.values* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* + +Returns an list of values in the array + +**Returns:** `IterableIterator`<`number`> + ___ @@ -145,7 +783,7 @@ ___ ▸ **decodeExtrinsicEra**(value?: *`AnyU8a`*): `Uint8Array` -*Defined in [ExtrinsicEra.ts:18](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ExtrinsicEra.ts#L18)* +*Defined in [ExtrinsicEra.ts:18](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ExtrinsicEra.ts#L18)* **Parameters:** @@ -156,23 +794,4 @@ ___ **Returns:** `Uint8Array` ___ - - -## `` decodeU8a - -▸ **decodeU8a**(value: *`any`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)* - -*Defined in [codec/U8a.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L21)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** `Uint8Array` - -___ diff --git a/docs/types/classes/_extrinsics_.extrinsics.md b/docs/types/classes/_extrinsics_.extrinsics.md index 5e1b214677..5b3153e781 100644 --- a/docs/types/classes/_extrinsics_.extrinsics.md +++ b/docs/types/classes/_extrinsics_.extrinsics.md @@ -16,20 +16,20 @@ ## constructor -⊕ **new Extrinsics**(Type: *`Constructor`<`T`>*, value?: * [Vector](_codec_vector_.vector.md)<`any`> | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `string` | `Array`<`any`>*): [Extrinsics](_extrinsics_.extrinsics.md) +⊕ **new Extrinsics**(Type: *`Constructor`<`T`>*, value?: * [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>*): [Extrinsics](_extrinsics_.extrinsics.md) *Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Vector.ts:20](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L20)* +*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L19)* **Parameters:** | Param | Type | Default value | | ------ | ------ | ------ | | Type | `Constructor`<`T`> | - | -| `Default value` value | [Vector](_codec_vector_.vector.md)<`any`> | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `string` | `Array`<`any`>| [] as Array<any> | +| `Default value` value | [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>| [] as Array<any> | **Returns:** [Extrinsics](_extrinsics_.extrinsics.md) @@ -45,7 +45,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -59,7 +59,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:68](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L68)* +*Defined in [codec/Vector.ts:65](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L65)* **Returns:** `string` @@ -74,7 +74,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Vector.ts:76](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L76)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L73)* **Returns:** `number` @@ -87,7 +87,7 @@ getlength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)* -*Defined in [codec/Vector.ts:72](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L72)* +*Defined in [codec/Vector.ts:69](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L69)* **Returns:** `number` @@ -103,7 +103,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)* -*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L82)* +*Defined in [codec/Vector.ts:79](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L79)* **Parameters:** @@ -122,7 +122,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[find](_codec_vector_.vector.md#find)* -*Defined in [codec/Vector.ts:86](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L86)* +*Defined in [codec/Vector.ts:83](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L83)* **Parameters:** @@ -141,7 +141,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[forEach](_codec_vector_.vector.md#foreach)* -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L90)* +*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L87)* **Parameters:** @@ -160,7 +160,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[get](_codec_vector_.vector.md#get)* -*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L94)* +*Defined in [codec/Vector.ts:91](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L91)* **Parameters:** @@ -179,7 +179,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)* -*Defined in [codec/Vector.ts:98](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L98)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L95)* **Type parameters:** @@ -201,7 +201,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[push](_codec_vector_.vector.md#push)* -*Defined in [codec/Vector.ts:102](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L102)* +*Defined in [codec/Vector.ts:99](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L99)* **Parameters:** @@ -220,7 +220,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[reduce](_codec_vector_.vector.md#reduce)* -*Defined in [codec/Vector.ts:106](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L106)* +*Defined in [codec/Vector.ts:103](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L103)* **Type parameters:** @@ -245,7 +245,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L110)* +*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L107)* **Returns:** `any` @@ -260,7 +260,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L129)* +*Defined in [codec/Vector.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L126)* **Returns:** `string` @@ -275,7 +275,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Vector.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L116)* +*Defined in [codec/Vector.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L113)* **Parameters:** @@ -290,11 +290,11 @@ ___ ## `` decodeVector -▸ **decodeVector**<`T`>(Type: *`Constructor`<`T`>*, value: * [Vector](_codec_vector_.vector.md)<`any`> | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `string` | `Array`<`any`>*): `Array`<`T`> +▸ **decodeVector**<`T`>(Type: *`Constructor`<`T`>*, value: * [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>*): `Array`<`T`> *Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* -*Defined in [codec/Vector.ts:30](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L30)* +*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L29)* **Type parameters:** @@ -304,7 +304,7 @@ ___ | Param | Type | | ------ | ------ | | Type | `Constructor`<`T`> | -| value | [Vector](_codec_vector_.vector.md)<`any`> | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `string` | `Array`<`any`>| +| value | [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>| **Returns:** `Array`<`T`> @@ -317,7 +317,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:60](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L60)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L57)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md index a90bffb05b..4f088e85aa 100644 --- a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md +++ b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md @@ -21,17 +21,17 @@ ## constructor -⊕ **new ExtrinsicSignature**(value?: * `ExtrinsicSignatureValue` | [U8a](_codec_u8a_.u8a.md) | `Uint8Array`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) +⊕ **new ExtrinsicSignature**(value?: * `ExtrinsicSignatureValue` | `Uint8Array`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [ExtrinsicSignature.ts:37](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ExtrinsicSignature.ts#L37)* +*Defined in [ExtrinsicSignature.ts:36](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ExtrinsicSignature.ts#L36)* **Parameters:** | Param | Type | | ------ | ------ | -| `Optional` value | `ExtrinsicSignatureValue` | [U8a](_codec_u8a_.u8a.md) | `Uint8Array`| +| `Optional` value | `ExtrinsicSignatureValue` | `Uint8Array`| **Returns:** [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Overrides [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [ExtrinsicSignature.ts:67](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ExtrinsicSignature.ts#L67)* +*Defined in [ExtrinsicSignature.ts:64](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ExtrinsicSignature.ts#L64)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getera(): [ExtrinsicEra](_extrinsicera_.extrinsicera.md) -*Defined in [ExtrinsicSignature.ts:80](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ExtrinsicSignature.ts#L80)* +*Defined in [ExtrinsicSignature.ts:77](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ExtrinsicSignature.ts#L77)* **Returns:** [ExtrinsicEra](_extrinsicera_.extrinsicera.md) @@ -118,7 +118,7 @@ ___ getisSigned(): `boolean` -*Defined in [ExtrinsicSignature.ts:76](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ExtrinsicSignature.ts#L76)* +*Defined in [ExtrinsicSignature.ts:73](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ExtrinsicSignature.ts#L73)* **Returns:** `boolean` @@ -129,7 +129,7 @@ ___ getnonce(): `Nonce` -*Defined in [ExtrinsicSignature.ts:84](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ExtrinsicSignature.ts#L84)* +*Defined in [ExtrinsicSignature.ts:81](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ExtrinsicSignature.ts#L81)* **Returns:** `Nonce` @@ -140,7 +140,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [ExtrinsicSignature.ts:88](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ExtrinsicSignature.ts#L88)* +*Defined in [ExtrinsicSignature.ts:85](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ExtrinsicSignature.ts#L85)* **Returns:** [Signature](_signature_.signature.md) @@ -151,7 +151,7 @@ ___ getsigner(): [Address](_address_.address.md) -*Defined in [ExtrinsicSignature.ts:92](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ExtrinsicSignature.ts#L92)* +*Defined in [ExtrinsicSignature.ts:89](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ExtrinsicSignature.ts#L89)* **Returns:** [Address](_address_.address.md) @@ -162,7 +162,7 @@ ___ getversion(): `number` -*Defined in [ExtrinsicSignature.ts:96](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ExtrinsicSignature.ts#L96)* +*Defined in [ExtrinsicSignature.ts:93](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ExtrinsicSignature.ts#L93)* **Returns:** `number` @@ -191,7 +191,7 @@ ___ ▸ **addSignature**(method: *[Method](_method_.method.md)*, signerPair: *`KeyringPair`*, nonce: *`AnyNumber`*, blockHash: *`AnyU8a`*, era?: *`Uint8Array`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) -*Defined in [ExtrinsicSignature.ts:108](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ExtrinsicSignature.ts#L108)* +*Defined in [ExtrinsicSignature.ts:105](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ExtrinsicSignature.ts#L105)* **Parameters:** @@ -300,7 +300,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -373,7 +373,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -386,7 +386,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -399,7 +399,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -412,7 +412,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -425,7 +425,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [ExtrinsicSignature.ts:127](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ExtrinsicSignature.ts#L127)* +*Defined in [ExtrinsicSignature.ts:124](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ExtrinsicSignature.ts#L124)* **Parameters:** @@ -457,7 +457,7 @@ ___ ▸ **decodeExtrinsicSignature**(value: * [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) | `ExtrinsicSignatureValue` | `AnyU8a` | `undefined`*): `any` | `Uint8Array` -*Defined in [ExtrinsicSignature.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ExtrinsicSignature.ts#L47)* +*Defined in [ExtrinsicSignature.ts:46](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ExtrinsicSignature.ts#L46)* **Parameters:** @@ -476,7 +476,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicstatus_.broadcast.md b/docs/types/classes/_extrinsicstatus_.broadcast.md index 180a714ca7..9e2a3942ce 100644 --- a/docs/types/classes/_extrinsicstatus_.broadcast.md +++ b/docs/types/classes/_extrinsicstatus_.broadcast.md @@ -14,20 +14,20 @@ ## constructor -⊕ **new Broadcast**(Type: *`Constructor`<`T`>*, value?: * [Vector](_codec_vector_.vector.md)<`any`> | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `string` | `Array`<`any`>*): [Broadcast](_extrinsicstatus_.broadcast.md) +⊕ **new Broadcast**(Type: *`Constructor`<`T`>*, value?: * [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>*): [Broadcast](_extrinsicstatus_.broadcast.md) *Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Vector.ts:20](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L20)* +*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L19)* **Parameters:** | Param | Type | Default value | | ------ | ------ | ------ | | Type | `Constructor`<`T`> | - | -| `Default value` value | [Vector](_codec_vector_.vector.md)<`any`> | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `string` | `Array`<`any`>| [] as Array<any> | +| `Default value` value | [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>| [] as Array<any> | **Returns:** [Broadcast](_extrinsicstatus_.broadcast.md) @@ -43,7 +43,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -57,7 +57,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:68](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L68)* +*Defined in [codec/Vector.ts:65](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L65)* **Returns:** `string` @@ -72,7 +72,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Vector.ts:76](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L76)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L73)* **Returns:** `number` @@ -85,7 +85,7 @@ getlength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)* -*Defined in [codec/Vector.ts:72](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L72)* +*Defined in [codec/Vector.ts:69](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L69)* **Returns:** `number` @@ -101,7 +101,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)* -*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L82)* +*Defined in [codec/Vector.ts:79](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L79)* **Parameters:** @@ -120,7 +120,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[find](_codec_vector_.vector.md#find)* -*Defined in [codec/Vector.ts:86](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L86)* +*Defined in [codec/Vector.ts:83](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L83)* **Parameters:** @@ -139,7 +139,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[forEach](_codec_vector_.vector.md#foreach)* -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L90)* +*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L87)* **Parameters:** @@ -158,7 +158,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[get](_codec_vector_.vector.md#get)* -*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L94)* +*Defined in [codec/Vector.ts:91](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L91)* **Parameters:** @@ -177,7 +177,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)* -*Defined in [codec/Vector.ts:98](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L98)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L95)* **Type parameters:** @@ -199,7 +199,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[push](_codec_vector_.vector.md#push)* -*Defined in [codec/Vector.ts:102](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L102)* +*Defined in [codec/Vector.ts:99](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L99)* **Parameters:** @@ -218,7 +218,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[reduce](_codec_vector_.vector.md#reduce)* -*Defined in [codec/Vector.ts:106](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L106)* +*Defined in [codec/Vector.ts:103](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L103)* **Type parameters:** @@ -243,7 +243,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L110)* +*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L107)* **Returns:** `any` @@ -258,7 +258,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L129)* +*Defined in [codec/Vector.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L126)* **Returns:** `string` @@ -273,7 +273,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Vector.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L116)* +*Defined in [codec/Vector.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L113)* **Parameters:** @@ -288,11 +288,11 @@ ___ ## `` decodeVector -▸ **decodeVector**<`T`>(Type: *`Constructor`<`T`>*, value: * [Vector](_codec_vector_.vector.md)<`any`> | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `string` | `Array`<`any`>*): `Array`<`T`> +▸ **decodeVector**<`T`>(Type: *`Constructor`<`T`>*, value: * [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>*): `Array`<`T`> *Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* -*Defined in [codec/Vector.ts:30](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L30)* +*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L29)* **Type parameters:** @@ -302,7 +302,7 @@ ___ | Param | Type | | ------ | ------ | | Type | `Constructor`<`T`> | -| value | [Vector](_codec_vector_.vector.md)<`any`> | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `string` | `Array`<`any`>| +| value | [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>| **Returns:** `Array`<`T`> @@ -315,7 +315,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:60](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L60)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L57)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicstatus_.dropped.md b/docs/types/classes/_extrinsicstatus_.dropped.md index e04353ef45..ca869dd185 100644 --- a/docs/types/classes/_extrinsicstatus_.dropped.md +++ b/docs/types/classes/_extrinsicstatus_.dropped.md @@ -18,7 +18,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Null.ts:8](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Null.ts#L8)* +*Defined in [Null.ts:8](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Null.ts#L8)* **Returns:** [Dropped](_extrinsicstatus_.dropped.md) @@ -34,7 +34,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -50,7 +50,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [Null.ts:13](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Null.ts#L13)* +*Defined in [Null.ts:13](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Null.ts#L13)* **Returns:** `number` @@ -68,7 +68,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Null.ts#L17)* +*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Null.ts#L17)* **Returns:** `any` @@ -83,7 +83,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [Null.ts:25](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Null.ts#L25)* +*Defined in [Null.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Null.ts#L25)* **Returns:** `string` @@ -98,7 +98,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [Null.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Null.ts#L21)* +*Defined in [Null.ts:21](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Null.ts#L21)* **Parameters:** diff --git a/docs/types/classes/_extrinsicstatus_.extrinsicstatus.md b/docs/types/classes/_extrinsicstatus_.extrinsicstatus.md index bc6e9e19fc..98d41aa1cb 100644 --- a/docs/types/classes/_extrinsicstatus_.extrinsicstatus.md +++ b/docs/types/classes/_extrinsicstatus_.extrinsicstatus.md @@ -16,7 +16,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [ExtrinsicStatus.ts:23](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ExtrinsicStatus.ts#L23)* +*Defined in [ExtrinsicStatus.ts:23](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ExtrinsicStatus.ts#L23)* **Parameters:** @@ -39,7 +39,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -55,7 +55,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L97)* +*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L94)* **Returns:** `number` @@ -68,7 +68,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:85](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L85)* +*Defined in [codec/EnumType.ts:82](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L82)* **Returns:** `boolean` @@ -81,7 +81,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L89)* +*Defined in [codec/EnumType.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L86)* **Returns:** `string` @@ -94,7 +94,7 @@ getvalue(): [Base](_codec_base_.base.md)< [Finalised](_extrinsicstatus_.finalise *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:93](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L93)* +*Defined in [codec/EnumType.ts:90](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L90)* **Returns:** [Base](_codec_base_.base.md)< [Finalised](_extrinsicstatus_.finalised.md) | [Usurped](_extrinsicstatus_.usurped.md) | [Broadcast](_extrinsicstatus_.broadcast.md) | [Dropped](_extrinsicstatus_.dropped.md)> @@ -110,7 +110,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[setValue](_codec_enumtype_.enumtype.md#setvalue)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L98)* **Parameters:** @@ -132,7 +132,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L118)* +*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L115)* **Returns:** `any` @@ -145,7 +145,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:122](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L122)* +*Defined in [codec/EnumType.ts:119](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L119)* **Returns:** `number` @@ -160,7 +160,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/EnumType.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L126)* +*Defined in [codec/EnumType.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L123)* **Returns:** `string` @@ -175,7 +175,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/EnumType.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L130)* +*Defined in [codec/EnumType.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L127)* **Parameters:** @@ -194,7 +194,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[decodeEnumType](_codec_enumtype_.enumtype.md#decodeenumtype)* -*Defined in [codec/EnumType.ts:46](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L46)* +*Defined in [codec/EnumType.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L45)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicstatus_.finalised.md b/docs/types/classes/_extrinsicstatus_.finalised.md index 8beda5e20d..07a7e4ee29 100644 --- a/docs/types/classes/_extrinsicstatus_.finalised.md +++ b/docs/types/classes/_extrinsicstatus_.finalised.md @@ -6,6 +6,13 @@ **↳ Finalised** +# Implements + +* `Codec` + +# Indexable + +\[index: `number`\]: `number` # Constructors @@ -18,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/H256.ts#L11)* +*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/H256.ts#L11)* **Parameters:** @@ -32,44 +39,118 @@ ___ # Properties - + -## raw +## BYTES_PER_ELEMENT -**● raw**: *`Uint8Array`* +**● BYTES_PER_ELEMENT**: *`number`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from Uint8Array.BYTES_PER_ELEMENT* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1886* + +The size in bytes of each element in the array. ___ + -# Accessors +## __@toStringTag - +**● __@toStringTag**: *"UInt8Array"* -## encodedLength +*Inherited from Uint8Array.[Symbol.toStringTag]* -getencodedLength(): `number` +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[encodedLength](_codec_u8afixed_.u8afixed.md#encodedlength)* +___ + -*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* +## buffer -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8aFixed.ts#L32)* +**● buffer**: *`ArrayBufferLike`* -**Returns:** `number` +*Inherited from Uint8Array.buffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1891* + +The ArrayBuffer instance referenced by the array. + +___ + + +## byteLength + +**● byteLength**: *`number`* + +*Inherited from Uint8Array.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1896* + +The length in bytes of the array. + +___ + + +## byteOffset + +**● byteOffset**: *`number`* + +*Inherited from Uint8Array.byteOffset* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1901* + +The offset in bytes of the array. ___ ## length -getlength(): `number` +**● length**: *`number`* -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* +*Inherited from Uint8Array.length* -*Defined in [codec/U8a.ts:31](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L31)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2000* + +The length of the array. + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* + +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* + +___ + +# Accessors + + + +## bitLength + +getbitLength(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + +___ + + +## encodedLength + +getencodedLength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* + +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L39)* **Returns:** `number` @@ -77,6 +158,550 @@ ___ # Methods + + +## __@iterator + +▸ **__@iterator**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.[Symbol.iterator]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* + +**Returns:** `IterableIterator`<`number`> + +___ + + +## copyWithin + +▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.copyWithin* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1912* + +Returns the this object after copying a section of the array identified by start and end to the same array starting at position target + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | +| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | +| `Optional` end | `undefined` | `number`| If not specified, length of the this object is used as its default value. | + +**Returns:** `this` + +___ + + +## entries + +▸ **entries**(): `IterableIterator`<[`number`, `number`]> + +*Inherited from Uint8Array.entries* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* + +Returns an array of key, value pairs for every entry in the array + +**Returns:** `IterableIterator`<[`number`, `number`]> + +___ + + +## every + +▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.every* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1922* + +Determines whether all the members of an array satisfy the specified test. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## fill + +▸ **fill**(value: *`number`*, start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.fill* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1932* + +Returns the this object after filling the section identified by start and end with value + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| value | `number` | value to fill array section with | +| `Optional` start | `undefined` | `number`| index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | +| `Optional` end | `undefined` | `number`| index to stop filling the array at. If end is negative, it is treated as length+end. | + +**Returns:** `this` + +___ + + +## filter + +▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.filter* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1941* + +Returns the elements of an array that meet the condition specified in a callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## find + +▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` | `undefined` + +*Inherited from Uint8Array.find* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1952* + +Returns the value of the first element in the array where predicate is true, and undefined otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` | `undefined` + +___ + + +## findIndex + +▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` + +*Inherited from Uint8Array.findIndex* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1963* + +Returns the index of the first element in the array where predicate is true, and -1 otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` + +___ + + +## forEach + +▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` + +*Inherited from Uint8Array.forEach* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* + +Performs the specified action for each element in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `void` + +___ + + +## includes + +▸ **includes**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `boolean` + +*Inherited from Uint8Array.includes* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* + +Determines whether an array includes a certain element, returning true or false as appropriate. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The element to search for. | +| `Optional` fromIndex | `undefined` | `number`| The position in this array at which to begin searching for searchElement. | + +**Returns:** `boolean` + +___ + + +## indexOf + +▸ **indexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.indexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1980* + +Returns the index of the first occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## join + +▸ **join**(separator?: * `undefined` | `string`*): `string` + +*Inherited from Uint8Array.join* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1987* + +Adds all the elements of an array separated by the specified separator string. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` separator | `undefined` | `string`| A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | + +**Returns:** `string` + +___ + + +## keys + +▸ **keys**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.keys* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* + +Returns an list of keys in the array + +**Returns:** `IterableIterator`<`number`> + +___ + + +## lastIndexOf + +▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.lastIndexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1995* + +Returns the index of the last occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## map + +▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.map* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2010* + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## reduce + +▸ **reduce**(callbackfn: *`function`*): `number` + +▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2022* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2023* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2035* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reduceRight + +▸ **reduceRight**(callbackfn: *`function`*): `number` + +▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2047* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2060* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reverse + +▸ **reverse**(): `Uint8Array` + +*Inherited from Uint8Array.reverse* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2065* + +Reverses the elements in an Array. + +**Returns:** `Uint8Array` + +___ + + +## set + +▸ **set**(array: *`ArrayLike`<`number`>*, offset?: * `undefined` | `number`*): `void` + +*Inherited from Uint8Array.set* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2072* + +Sets a value or an array of values. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | +| `Optional` offset | `undefined` | `number`| The index in the current array at which the values are to be written. | + +**Returns:** `void` + +___ + + +## slice + +▸ **slice**(start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.slice* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2079* + +Returns a section of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` start | `undefined` | `number`| The beginning of the specified portion of the array. | +| `Optional` end | `undefined` | `number`| The end of the specified portion of the array. | + +**Returns:** `Uint8Array` + +___ + + +## some + +▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.some* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2089* + +Determines whether the specified callback function returns true for any element of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## sort + +▸ **sort**(compareFn?: * `undefined` | `function`*): `this` + +*Inherited from Uint8Array.sort* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2096* + +Sorts an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` compareFn | `undefined` | `function`| The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | + +**Returns:** `this` + +___ + + +## subarray + +▸ **subarray**(begin: *`number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.subarray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2104* + +Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| begin | `number` | The index of the beginning of the array. | +| `Optional` end | `undefined` | `number`| The index of the end of the array. | + +**Returns:** `Uint8Array` + +___ ## toHex @@ -85,7 +710,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -98,12 +723,25 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` +___ + + +## toLocaleString + +▸ **toLocaleString**(): `string` + +*Inherited from Uint8Array.toLocaleString* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2109* + +Converts a number to a string by using the current locale. + +**Returns:** `string` + ___ @@ -113,9 +751,9 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -128,9 +766,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L51)* **Parameters:** @@ -141,23 +777,19 @@ ___ **Returns:** `Uint8Array` ___ - + -## `` decodeU8a +## values -▸ **decodeU8a**(value: *`any`*): `Uint8Array` +▸ **values**(): `IterableIterator`<`number`> -*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)* +*Inherited from Uint8Array.values* -*Defined in [codec/U8a.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L21)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* -**Parameters:** +Returns an list of values in the array -| Param | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** `Uint8Array` +**Returns:** `IterableIterator`<`number`> ___ diff --git a/docs/types/classes/_extrinsicstatus_.usurped.md b/docs/types/classes/_extrinsicstatus_.usurped.md index 227e3eeee0..4e09c54f64 100644 --- a/docs/types/classes/_extrinsicstatus_.usurped.md +++ b/docs/types/classes/_extrinsicstatus_.usurped.md @@ -6,6 +6,13 @@ **↳ Usurped** +# Implements + +* `Codec` + +# Indexable + +\[index: `number`\]: `number` # Constructors @@ -18,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/H256.ts#L11)* +*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/H256.ts#L11)* **Parameters:** @@ -32,44 +39,118 @@ ___ # Properties - + -## raw +## BYTES_PER_ELEMENT -**● raw**: *`Uint8Array`* +**● BYTES_PER_ELEMENT**: *`number`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from Uint8Array.BYTES_PER_ELEMENT* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1886* + +The size in bytes of each element in the array. ___ + -# Accessors +## __@toStringTag - +**● __@toStringTag**: *"UInt8Array"* -## encodedLength +*Inherited from Uint8Array.[Symbol.toStringTag]* -getencodedLength(): `number` +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[encodedLength](_codec_u8afixed_.u8afixed.md#encodedlength)* +___ + -*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* +## buffer -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8aFixed.ts#L32)* +**● buffer**: *`ArrayBufferLike`* -**Returns:** `number` +*Inherited from Uint8Array.buffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1891* + +The ArrayBuffer instance referenced by the array. + +___ + + +## byteLength + +**● byteLength**: *`number`* + +*Inherited from Uint8Array.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1896* + +The length in bytes of the array. + +___ + + +## byteOffset + +**● byteOffset**: *`number`* + +*Inherited from Uint8Array.byteOffset* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1901* + +The offset in bytes of the array. ___ ## length -getlength(): `number` +**● length**: *`number`* -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* +*Inherited from Uint8Array.length* -*Defined in [codec/U8a.ts:31](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L31)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2000* + +The length of the array. + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* + +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* + +___ + +# Accessors + + + +## bitLength + +getbitLength(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + +___ + + +## encodedLength + +getencodedLength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* + +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L39)* **Returns:** `number` @@ -77,6 +158,550 @@ ___ # Methods + + +## __@iterator + +▸ **__@iterator**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.[Symbol.iterator]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* + +**Returns:** `IterableIterator`<`number`> + +___ + + +## copyWithin + +▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.copyWithin* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1912* + +Returns the this object after copying a section of the array identified by start and end to the same array starting at position target + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | +| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | +| `Optional` end | `undefined` | `number`| If not specified, length of the this object is used as its default value. | + +**Returns:** `this` + +___ + + +## entries + +▸ **entries**(): `IterableIterator`<[`number`, `number`]> + +*Inherited from Uint8Array.entries* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* + +Returns an array of key, value pairs for every entry in the array + +**Returns:** `IterableIterator`<[`number`, `number`]> + +___ + + +## every + +▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.every* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1922* + +Determines whether all the members of an array satisfy the specified test. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## fill + +▸ **fill**(value: *`number`*, start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.fill* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1932* + +Returns the this object after filling the section identified by start and end with value + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| value | `number` | value to fill array section with | +| `Optional` start | `undefined` | `number`| index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | +| `Optional` end | `undefined` | `number`| index to stop filling the array at. If end is negative, it is treated as length+end. | + +**Returns:** `this` + +___ + + +## filter + +▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.filter* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1941* + +Returns the elements of an array that meet the condition specified in a callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## find + +▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` | `undefined` + +*Inherited from Uint8Array.find* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1952* + +Returns the value of the first element in the array where predicate is true, and undefined otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` | `undefined` + +___ + + +## findIndex + +▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` + +*Inherited from Uint8Array.findIndex* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1963* + +Returns the index of the first element in the array where predicate is true, and -1 otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` + +___ + + +## forEach + +▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` + +*Inherited from Uint8Array.forEach* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* + +Performs the specified action for each element in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `void` + +___ + + +## includes + +▸ **includes**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `boolean` + +*Inherited from Uint8Array.includes* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* + +Determines whether an array includes a certain element, returning true or false as appropriate. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The element to search for. | +| `Optional` fromIndex | `undefined` | `number`| The position in this array at which to begin searching for searchElement. | + +**Returns:** `boolean` + +___ + + +## indexOf + +▸ **indexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.indexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1980* + +Returns the index of the first occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## join + +▸ **join**(separator?: * `undefined` | `string`*): `string` + +*Inherited from Uint8Array.join* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1987* + +Adds all the elements of an array separated by the specified separator string. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` separator | `undefined` | `string`| A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | + +**Returns:** `string` + +___ + + +## keys + +▸ **keys**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.keys* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* + +Returns an list of keys in the array + +**Returns:** `IterableIterator`<`number`> + +___ + + +## lastIndexOf + +▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.lastIndexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1995* + +Returns the index of the last occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## map + +▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.map* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2010* + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## reduce + +▸ **reduce**(callbackfn: *`function`*): `number` + +▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2022* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2023* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2035* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reduceRight + +▸ **reduceRight**(callbackfn: *`function`*): `number` + +▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2047* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2060* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reverse + +▸ **reverse**(): `Uint8Array` + +*Inherited from Uint8Array.reverse* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2065* + +Reverses the elements in an Array. + +**Returns:** `Uint8Array` + +___ + + +## set + +▸ **set**(array: *`ArrayLike`<`number`>*, offset?: * `undefined` | `number`*): `void` + +*Inherited from Uint8Array.set* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2072* + +Sets a value or an array of values. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | +| `Optional` offset | `undefined` | `number`| The index in the current array at which the values are to be written. | + +**Returns:** `void` + +___ + + +## slice + +▸ **slice**(start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.slice* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2079* + +Returns a section of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` start | `undefined` | `number`| The beginning of the specified portion of the array. | +| `Optional` end | `undefined` | `number`| The end of the specified portion of the array. | + +**Returns:** `Uint8Array` + +___ + + +## some + +▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.some* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2089* + +Determines whether the specified callback function returns true for any element of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## sort + +▸ **sort**(compareFn?: * `undefined` | `function`*): `this` + +*Inherited from Uint8Array.sort* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2096* + +Sorts an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` compareFn | `undefined` | `function`| The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | + +**Returns:** `this` + +___ + + +## subarray + +▸ **subarray**(begin: *`number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.subarray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2104* + +Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| begin | `number` | The index of the beginning of the array. | +| `Optional` end | `undefined` | `number`| The index of the end of the array. | + +**Returns:** `Uint8Array` + +___ ## toHex @@ -85,7 +710,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -98,12 +723,25 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` +___ + + +## toLocaleString + +▸ **toLocaleString**(): `string` + +*Inherited from Uint8Array.toLocaleString* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2109* + +Converts a number to a string by using the current locale. + +**Returns:** `string` + ___ @@ -113,9 +751,9 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -128,9 +766,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L51)* **Parameters:** @@ -141,23 +777,19 @@ ___ **Returns:** `Uint8Array` ___ - + -## `` decodeU8a +## values -▸ **decodeU8a**(value: *`any`*): `Uint8Array` +▸ **values**(): `IterableIterator`<`number`> -*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)* +*Inherited from Uint8Array.values* -*Defined in [codec/U8a.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L21)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* -**Parameters:** +Returns an list of values in the array -| Param | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** `Uint8Array` +**Returns:** `IterableIterator`<`number`> ___ diff --git a/docs/types/classes/_gas_.gas.md b/docs/types/classes/_gas_.gas.md index a8635bb046..b6a4afc9bb 100644 --- a/docs/types/classes/_gas_.gas.md +++ b/docs/types/classes/_gas_.gas.md @@ -18,7 +18,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U64.ts#L9)* +*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U64.ts#L9)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -69,7 +69,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -85,7 +85,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -104,7 +104,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -123,7 +123,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -142,7 +142,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -161,7 +161,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -180,7 +180,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -199,7 +199,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -212,7 +212,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -231,7 +231,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -250,7 +250,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -269,7 +269,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -288,7 +288,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -301,7 +301,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -316,7 +316,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -329,7 +329,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -344,7 +344,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -359,7 +359,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -378,7 +378,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_h256_.h256.md b/docs/types/classes/_h256_.h256.md index 64fb31285a..0aa6ce3f47 100644 --- a/docs/types/classes/_h256_.h256.md +++ b/docs/types/classes/_h256_.h256.md @@ -8,6 +8,13 @@ ↳ [Hash](_hash_.hash.md) +# Implements + +* `Codec` + +# Indexable + +\[index: `number`\]: `number` # Constructors @@ -18,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/H256.ts#L11)* +*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/H256.ts#L11)* **Parameters:** @@ -32,44 +39,118 @@ ___ # Properties - + -## raw +## BYTES_PER_ELEMENT -**● raw**: *`Uint8Array`* +**● BYTES_PER_ELEMENT**: *`number`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from Uint8Array.BYTES_PER_ELEMENT* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1886* + +The size in bytes of each element in the array. ___ + -# Accessors +## __@toStringTag - +**● __@toStringTag**: *"UInt8Array"* -## encodedLength +*Inherited from Uint8Array.[Symbol.toStringTag]* -getencodedLength(): `number` +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[encodedLength](_codec_u8afixed_.u8afixed.md#encodedlength)* +___ + -*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* +## buffer -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8aFixed.ts#L32)* +**● buffer**: *`ArrayBufferLike`* -**Returns:** `number` +*Inherited from Uint8Array.buffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1891* + +The ArrayBuffer instance referenced by the array. + +___ + + +## byteLength + +**● byteLength**: *`number`* + +*Inherited from Uint8Array.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1896* + +The length in bytes of the array. + +___ + + +## byteOffset + +**● byteOffset**: *`number`* + +*Inherited from Uint8Array.byteOffset* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1901* + +The offset in bytes of the array. ___ ## length -getlength(): `number` +**● length**: *`number`* -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* +*Inherited from Uint8Array.length* -*Defined in [codec/U8a.ts:31](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L31)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2000* + +The length of the array. + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* + +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* + +___ + +# Accessors + + + +## bitLength + +getbitLength(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + +___ + + +## encodedLength + +getencodedLength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* + +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L39)* **Returns:** `number` @@ -77,6 +158,550 @@ ___ # Methods + + +## __@iterator + +▸ **__@iterator**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.[Symbol.iterator]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* + +**Returns:** `IterableIterator`<`number`> + +___ + + +## copyWithin + +▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.copyWithin* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1912* + +Returns the this object after copying a section of the array identified by start and end to the same array starting at position target + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | +| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | +| `Optional` end | `undefined` | `number`| If not specified, length of the this object is used as its default value. | + +**Returns:** `this` + +___ + + +## entries + +▸ **entries**(): `IterableIterator`<[`number`, `number`]> + +*Inherited from Uint8Array.entries* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* + +Returns an array of key, value pairs for every entry in the array + +**Returns:** `IterableIterator`<[`number`, `number`]> + +___ + + +## every + +▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.every* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1922* + +Determines whether all the members of an array satisfy the specified test. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## fill + +▸ **fill**(value: *`number`*, start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.fill* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1932* + +Returns the this object after filling the section identified by start and end with value + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| value | `number` | value to fill array section with | +| `Optional` start | `undefined` | `number`| index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | +| `Optional` end | `undefined` | `number`| index to stop filling the array at. If end is negative, it is treated as length+end. | + +**Returns:** `this` + +___ + + +## filter + +▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.filter* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1941* + +Returns the elements of an array that meet the condition specified in a callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## find + +▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` | `undefined` + +*Inherited from Uint8Array.find* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1952* + +Returns the value of the first element in the array where predicate is true, and undefined otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` | `undefined` + +___ + + +## findIndex + +▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` + +*Inherited from Uint8Array.findIndex* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1963* + +Returns the index of the first element in the array where predicate is true, and -1 otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` + +___ + + +## forEach + +▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` + +*Inherited from Uint8Array.forEach* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* + +Performs the specified action for each element in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `void` + +___ + + +## includes + +▸ **includes**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `boolean` + +*Inherited from Uint8Array.includes* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* + +Determines whether an array includes a certain element, returning true or false as appropriate. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The element to search for. | +| `Optional` fromIndex | `undefined` | `number`| The position in this array at which to begin searching for searchElement. | + +**Returns:** `boolean` + +___ + + +## indexOf + +▸ **indexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.indexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1980* + +Returns the index of the first occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## join + +▸ **join**(separator?: * `undefined` | `string`*): `string` + +*Inherited from Uint8Array.join* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1987* + +Adds all the elements of an array separated by the specified separator string. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` separator | `undefined` | `string`| A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | + +**Returns:** `string` + +___ + + +## keys + +▸ **keys**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.keys* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* + +Returns an list of keys in the array + +**Returns:** `IterableIterator`<`number`> + +___ + + +## lastIndexOf + +▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.lastIndexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1995* + +Returns the index of the last occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## map + +▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.map* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2010* + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## reduce + +▸ **reduce**(callbackfn: *`function`*): `number` + +▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2022* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2023* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2035* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reduceRight + +▸ **reduceRight**(callbackfn: *`function`*): `number` + +▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2047* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2060* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reverse + +▸ **reverse**(): `Uint8Array` + +*Inherited from Uint8Array.reverse* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2065* + +Reverses the elements in an Array. + +**Returns:** `Uint8Array` + +___ + + +## set + +▸ **set**(array: *`ArrayLike`<`number`>*, offset?: * `undefined` | `number`*): `void` + +*Inherited from Uint8Array.set* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2072* + +Sets a value or an array of values. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | +| `Optional` offset | `undefined` | `number`| The index in the current array at which the values are to be written. | + +**Returns:** `void` + +___ + + +## slice + +▸ **slice**(start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.slice* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2079* + +Returns a section of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` start | `undefined` | `number`| The beginning of the specified portion of the array. | +| `Optional` end | `undefined` | `number`| The end of the specified portion of the array. | + +**Returns:** `Uint8Array` + +___ + + +## some + +▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.some* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2089* + +Determines whether the specified callback function returns true for any element of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## sort + +▸ **sort**(compareFn?: * `undefined` | `function`*): `this` + +*Inherited from Uint8Array.sort* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2096* + +Sorts an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` compareFn | `undefined` | `function`| The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | + +**Returns:** `this` + +___ + + +## subarray + +▸ **subarray**(begin: *`number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.subarray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2104* + +Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| begin | `number` | The index of the beginning of the array. | +| `Optional` end | `undefined` | `number`| The index of the end of the array. | + +**Returns:** `Uint8Array` + +___ ## toHex @@ -85,7 +710,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -98,12 +723,25 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` +___ + + +## toLocaleString + +▸ **toLocaleString**(): `string` + +*Inherited from Uint8Array.toLocaleString* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2109* + +Converts a number to a string by using the current locale. + +**Returns:** `string` + ___ @@ -113,9 +751,9 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -128,9 +766,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L51)* **Parameters:** @@ -141,23 +777,19 @@ ___ **Returns:** `Uint8Array` ___ - + -## `` decodeU8a +## values -▸ **decodeU8a**(value: *`any`*): `Uint8Array` +▸ **values**(): `IterableIterator`<`number`> -*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)* +*Inherited from Uint8Array.values* -*Defined in [codec/U8a.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L21)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* -**Parameters:** +Returns an list of values in the array -| Param | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** `Uint8Array` +**Returns:** `IterableIterator`<`number`> ___ diff --git a/docs/types/classes/_h512_.h512.md b/docs/types/classes/_h512_.h512.md index cfbebdb978..814c363a93 100644 --- a/docs/types/classes/_h512_.h512.md +++ b/docs/types/classes/_h512_.h512.md @@ -8,6 +8,13 @@ ↳ [Signature](_signature_.signature.md) +# Implements + +* `Codec` + +# Indexable + +\[index: `number`\]: `number` # Constructors @@ -18,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:10](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/H512.ts#L10)* +*Defined in [H512.ts:10](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/H512.ts#L10)* **Parameters:** @@ -32,44 +39,118 @@ ___ # Properties - + -## raw +## BYTES_PER_ELEMENT -**● raw**: *`Uint8Array`* +**● BYTES_PER_ELEMENT**: *`number`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from Uint8Array.BYTES_PER_ELEMENT* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1886* + +The size in bytes of each element in the array. ___ + -# Accessors +## __@toStringTag - +**● __@toStringTag**: *"UInt8Array"* -## encodedLength +*Inherited from Uint8Array.[Symbol.toStringTag]* -getencodedLength(): `number` +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[encodedLength](_codec_u8afixed_.u8afixed.md#encodedlength)* +___ + -*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* +## buffer -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8aFixed.ts#L32)* +**● buffer**: *`ArrayBufferLike`* -**Returns:** `number` +*Inherited from Uint8Array.buffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1891* + +The ArrayBuffer instance referenced by the array. + +___ + + +## byteLength + +**● byteLength**: *`number`* + +*Inherited from Uint8Array.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1896* + +The length in bytes of the array. + +___ + + +## byteOffset + +**● byteOffset**: *`number`* + +*Inherited from Uint8Array.byteOffset* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1901* + +The offset in bytes of the array. ___ ## length -getlength(): `number` +**● length**: *`number`* -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* +*Inherited from Uint8Array.length* -*Defined in [codec/U8a.ts:31](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L31)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2000* + +The length of the array. + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* + +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* + +___ + +# Accessors + + + +## bitLength + +getbitLength(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + +___ + + +## encodedLength + +getencodedLength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* + +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L39)* **Returns:** `number` @@ -77,6 +158,550 @@ ___ # Methods + + +## __@iterator + +▸ **__@iterator**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.[Symbol.iterator]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* + +**Returns:** `IterableIterator`<`number`> + +___ + + +## copyWithin + +▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.copyWithin* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1912* + +Returns the this object after copying a section of the array identified by start and end to the same array starting at position target + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | +| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | +| `Optional` end | `undefined` | `number`| If not specified, length of the this object is used as its default value. | + +**Returns:** `this` + +___ + + +## entries + +▸ **entries**(): `IterableIterator`<[`number`, `number`]> + +*Inherited from Uint8Array.entries* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* + +Returns an array of key, value pairs for every entry in the array + +**Returns:** `IterableIterator`<[`number`, `number`]> + +___ + + +## every + +▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.every* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1922* + +Determines whether all the members of an array satisfy the specified test. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## fill + +▸ **fill**(value: *`number`*, start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.fill* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1932* + +Returns the this object after filling the section identified by start and end with value + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| value | `number` | value to fill array section with | +| `Optional` start | `undefined` | `number`| index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | +| `Optional` end | `undefined` | `number`| index to stop filling the array at. If end is negative, it is treated as length+end. | + +**Returns:** `this` + +___ + + +## filter + +▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.filter* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1941* + +Returns the elements of an array that meet the condition specified in a callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## find + +▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` | `undefined` + +*Inherited from Uint8Array.find* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1952* + +Returns the value of the first element in the array where predicate is true, and undefined otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` | `undefined` + +___ + + +## findIndex + +▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` + +*Inherited from Uint8Array.findIndex* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1963* + +Returns the index of the first element in the array where predicate is true, and -1 otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` + +___ + + +## forEach + +▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` + +*Inherited from Uint8Array.forEach* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* + +Performs the specified action for each element in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `void` + +___ + + +## includes + +▸ **includes**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `boolean` + +*Inherited from Uint8Array.includes* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* + +Determines whether an array includes a certain element, returning true or false as appropriate. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The element to search for. | +| `Optional` fromIndex | `undefined` | `number`| The position in this array at which to begin searching for searchElement. | + +**Returns:** `boolean` + +___ + + +## indexOf + +▸ **indexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.indexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1980* + +Returns the index of the first occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## join + +▸ **join**(separator?: * `undefined` | `string`*): `string` + +*Inherited from Uint8Array.join* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1987* + +Adds all the elements of an array separated by the specified separator string. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` separator | `undefined` | `string`| A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | + +**Returns:** `string` + +___ + + +## keys + +▸ **keys**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.keys* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* + +Returns an list of keys in the array + +**Returns:** `IterableIterator`<`number`> + +___ + + +## lastIndexOf + +▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.lastIndexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1995* + +Returns the index of the last occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## map + +▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.map* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2010* + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## reduce + +▸ **reduce**(callbackfn: *`function`*): `number` + +▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2022* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2023* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2035* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reduceRight + +▸ **reduceRight**(callbackfn: *`function`*): `number` + +▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2047* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2060* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reverse + +▸ **reverse**(): `Uint8Array` + +*Inherited from Uint8Array.reverse* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2065* + +Reverses the elements in an Array. + +**Returns:** `Uint8Array` + +___ + + +## set + +▸ **set**(array: *`ArrayLike`<`number`>*, offset?: * `undefined` | `number`*): `void` + +*Inherited from Uint8Array.set* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2072* + +Sets a value or an array of values. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | +| `Optional` offset | `undefined` | `number`| The index in the current array at which the values are to be written. | + +**Returns:** `void` + +___ + + +## slice + +▸ **slice**(start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.slice* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2079* + +Returns a section of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` start | `undefined` | `number`| The beginning of the specified portion of the array. | +| `Optional` end | `undefined` | `number`| The end of the specified portion of the array. | + +**Returns:** `Uint8Array` + +___ + + +## some + +▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.some* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2089* + +Determines whether the specified callback function returns true for any element of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## sort + +▸ **sort**(compareFn?: * `undefined` | `function`*): `this` + +*Inherited from Uint8Array.sort* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2096* + +Sorts an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` compareFn | `undefined` | `function`| The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | + +**Returns:** `this` + +___ + + +## subarray + +▸ **subarray**(begin: *`number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.subarray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2104* + +Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| begin | `number` | The index of the beginning of the array. | +| `Optional` end | `undefined` | `number`| The index of the end of the array. | + +**Returns:** `Uint8Array` + +___ ## toHex @@ -85,7 +710,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -98,12 +723,25 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` +___ + + +## toLocaleString + +▸ **toLocaleString**(): `string` + +*Inherited from Uint8Array.toLocaleString* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2109* + +Converts a number to a string by using the current locale. + +**Returns:** `string` + ___ @@ -113,9 +751,9 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -128,9 +766,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L51)* **Parameters:** @@ -141,23 +777,19 @@ ___ **Returns:** `Uint8Array` ___ - + -## `` decodeU8a +## values -▸ **decodeU8a**(value: *`any`*): `Uint8Array` +▸ **values**(): `IterableIterator`<`number`> -*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)* +*Inherited from Uint8Array.values* -*Defined in [codec/U8a.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L21)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* -**Parameters:** +Returns an list of values in the array -| Param | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** `Uint8Array` +**Returns:** `IterableIterator`<`number`> ___ diff --git a/docs/types/classes/_hash_.hash.md b/docs/types/classes/_hash_.hash.md index 66b62834b2..094b4d0f84 100644 --- a/docs/types/classes/_hash_.hash.md +++ b/docs/types/classes/_hash_.hash.md @@ -10,6 +10,13 @@ ↳ [Usurped](_extrinsicstatus_.usurped.md) +# Implements + +* `Codec` + +# Indexable + +\[index: `number`\]: `number` # Constructors @@ -22,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/H256.ts#L11)* +*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/H256.ts#L11)* **Parameters:** @@ -36,44 +43,118 @@ ___ # Properties - + -## raw +## BYTES_PER_ELEMENT -**● raw**: *`Uint8Array`* +**● BYTES_PER_ELEMENT**: *`number`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from Uint8Array.BYTES_PER_ELEMENT* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1886* + +The size in bytes of each element in the array. ___ + -# Accessors +## __@toStringTag - +**● __@toStringTag**: *"UInt8Array"* -## encodedLength +*Inherited from Uint8Array.[Symbol.toStringTag]* -getencodedLength(): `number` +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[encodedLength](_codec_u8afixed_.u8afixed.md#encodedlength)* +___ + -*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* +## buffer -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8aFixed.ts#L32)* +**● buffer**: *`ArrayBufferLike`* -**Returns:** `number` +*Inherited from Uint8Array.buffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1891* + +The ArrayBuffer instance referenced by the array. + +___ + + +## byteLength + +**● byteLength**: *`number`* + +*Inherited from Uint8Array.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1896* + +The length in bytes of the array. + +___ + + +## byteOffset + +**● byteOffset**: *`number`* + +*Inherited from Uint8Array.byteOffset* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1901* + +The offset in bytes of the array. ___ ## length -getlength(): `number` +**● length**: *`number`* -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* +*Inherited from Uint8Array.length* -*Defined in [codec/U8a.ts:31](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L31)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2000* + +The length of the array. + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* + +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* + +___ + +# Accessors + + + +## bitLength + +getbitLength(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + +___ + + +## encodedLength + +getencodedLength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* + +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L39)* **Returns:** `number` @@ -81,6 +162,550 @@ ___ # Methods + + +## __@iterator + +▸ **__@iterator**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.[Symbol.iterator]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* + +**Returns:** `IterableIterator`<`number`> + +___ + + +## copyWithin + +▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.copyWithin* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1912* + +Returns the this object after copying a section of the array identified by start and end to the same array starting at position target + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | +| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | +| `Optional` end | `undefined` | `number`| If not specified, length of the this object is used as its default value. | + +**Returns:** `this` + +___ + + +## entries + +▸ **entries**(): `IterableIterator`<[`number`, `number`]> + +*Inherited from Uint8Array.entries* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* + +Returns an array of key, value pairs for every entry in the array + +**Returns:** `IterableIterator`<[`number`, `number`]> + +___ + + +## every + +▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.every* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1922* + +Determines whether all the members of an array satisfy the specified test. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## fill + +▸ **fill**(value: *`number`*, start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.fill* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1932* + +Returns the this object after filling the section identified by start and end with value + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| value | `number` | value to fill array section with | +| `Optional` start | `undefined` | `number`| index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | +| `Optional` end | `undefined` | `number`| index to stop filling the array at. If end is negative, it is treated as length+end. | + +**Returns:** `this` + +___ + + +## filter + +▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.filter* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1941* + +Returns the elements of an array that meet the condition specified in a callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## find + +▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` | `undefined` + +*Inherited from Uint8Array.find* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1952* + +Returns the value of the first element in the array where predicate is true, and undefined otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` | `undefined` + +___ + + +## findIndex + +▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` + +*Inherited from Uint8Array.findIndex* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1963* + +Returns the index of the first element in the array where predicate is true, and -1 otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` + +___ + + +## forEach + +▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` + +*Inherited from Uint8Array.forEach* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* + +Performs the specified action for each element in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `void` + +___ + + +## includes + +▸ **includes**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `boolean` + +*Inherited from Uint8Array.includes* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* + +Determines whether an array includes a certain element, returning true or false as appropriate. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The element to search for. | +| `Optional` fromIndex | `undefined` | `number`| The position in this array at which to begin searching for searchElement. | + +**Returns:** `boolean` + +___ + + +## indexOf + +▸ **indexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.indexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1980* + +Returns the index of the first occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## join + +▸ **join**(separator?: * `undefined` | `string`*): `string` + +*Inherited from Uint8Array.join* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1987* + +Adds all the elements of an array separated by the specified separator string. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` separator | `undefined` | `string`| A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | + +**Returns:** `string` + +___ + + +## keys + +▸ **keys**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.keys* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* + +Returns an list of keys in the array + +**Returns:** `IterableIterator`<`number`> + +___ + + +## lastIndexOf + +▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.lastIndexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1995* + +Returns the index of the last occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## map + +▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.map* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2010* + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## reduce + +▸ **reduce**(callbackfn: *`function`*): `number` + +▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2022* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2023* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2035* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reduceRight + +▸ **reduceRight**(callbackfn: *`function`*): `number` + +▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2047* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2060* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reverse + +▸ **reverse**(): `Uint8Array` + +*Inherited from Uint8Array.reverse* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2065* + +Reverses the elements in an Array. + +**Returns:** `Uint8Array` + +___ + + +## set + +▸ **set**(array: *`ArrayLike`<`number`>*, offset?: * `undefined` | `number`*): `void` + +*Inherited from Uint8Array.set* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2072* + +Sets a value or an array of values. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | +| `Optional` offset | `undefined` | `number`| The index in the current array at which the values are to be written. | + +**Returns:** `void` + +___ + + +## slice + +▸ **slice**(start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.slice* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2079* + +Returns a section of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` start | `undefined` | `number`| The beginning of the specified portion of the array. | +| `Optional` end | `undefined` | `number`| The end of the specified portion of the array. | + +**Returns:** `Uint8Array` + +___ + + +## some + +▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.some* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2089* + +Determines whether the specified callback function returns true for any element of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## sort + +▸ **sort**(compareFn?: * `undefined` | `function`*): `this` + +*Inherited from Uint8Array.sort* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2096* + +Sorts an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` compareFn | `undefined` | `function`| The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | + +**Returns:** `this` + +___ + + +## subarray + +▸ **subarray**(begin: *`number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.subarray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2104* + +Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| begin | `number` | The index of the beginning of the array. | +| `Optional` end | `undefined` | `number`| The index of the end of the array. | + +**Returns:** `Uint8Array` + +___ ## toHex @@ -89,7 +714,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -102,12 +727,25 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` +___ + + +## toLocaleString + +▸ **toLocaleString**(): `string` + +*Inherited from Uint8Array.toLocaleString* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2109* + +Converts a number to a string by using the current locale. + +**Returns:** `string` + ___ @@ -117,9 +755,9 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -132,9 +770,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L51)* **Parameters:** @@ -145,23 +781,19 @@ ___ **Returns:** `Uint8Array` ___ - + -## `` decodeU8a +## values -▸ **decodeU8a**(value: *`any`*): `Uint8Array` +▸ **values**(): `IterableIterator`<`number`> -*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)* +*Inherited from Uint8Array.values* -*Defined in [codec/U8a.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L21)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* -**Parameters:** +Returns an list of values in the array -| Param | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** `Uint8Array` +**Returns:** `IterableIterator`<`number`> ___ diff --git a/docs/types/classes/_header_.header.md b/docs/types/classes/_header_.header.md index 23b160af12..ff285a42b7 100644 --- a/docs/types/classes/_header_.header.md +++ b/docs/types/classes/_header_.header.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Header.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Header.ts#L26)* +*Defined in [Header.ts:26](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Header.ts#L26)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getblockNumber(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [Header.ts:37](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Header.ts#L37)* +*Defined in [Header.ts:37](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Header.ts#L37)* **Returns:** [BlockNumber](_blocknumber_.blocknumber.md) @@ -105,7 +105,7 @@ ___ getdigest(): [Digest](_digest_.digest.md) -*Defined in [Header.ts:41](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Header.ts#L41)* +*Defined in [Header.ts:41](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Header.ts#L41)* **Returns:** [Digest](_digest_.digest.md) @@ -118,7 +118,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -129,7 +129,7 @@ ___ getextrinsicsRoot(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:45](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Header.ts#L45)* +*Defined in [Header.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Header.ts#L45)* **Returns:** [Hash](_hash_.hash.md) @@ -140,7 +140,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:50](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Header.ts#L50)* +*Defined in [Header.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Header.ts#L50)* **Returns:** [Hash](_hash_.hash.md) @@ -151,7 +151,7 @@ ___ getparentHash(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:56](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Header.ts#L56)* +*Defined in [Header.ts:56](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Header.ts#L56)* **Returns:** [Hash](_hash_.hash.md) @@ -162,7 +162,7 @@ ___ getstateRoot(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:60](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Header.ts#L60)* +*Defined in [Header.ts:60](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Header.ts#L60)* **Returns:** [Hash](_hash_.hash.md) @@ -279,7 +279,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -352,7 +352,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -365,7 +365,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -378,7 +378,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -391,7 +391,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -404,7 +404,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -438,7 +438,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_keyvalue_.keyvalue.md b/docs/types/classes/_keyvalue_.keyvalue.md index befd68e229..873857c8c8 100644 --- a/docs/types/classes/_keyvalue_.keyvalue.md +++ b/docs/types/classes/_keyvalue_.keyvalue.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [KeyValue.ts:23](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/KeyValue.ts#L23)* +*Defined in [KeyValue.ts:23](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/KeyValue.ts#L23)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getkey(): [StorageKey](_storagekey_.storagekey.md) -*Defined in [KeyValue.ts:31](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/KeyValue.ts#L31)* +*Defined in [KeyValue.ts:31](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/KeyValue.ts#L31)* **Returns:** [StorageKey](_storagekey_.storagekey.md) @@ -118,7 +118,7 @@ ___ getvalue(): [StorageData](_storagedata_.storagedata.md) -*Defined in [KeyValue.ts:35](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/KeyValue.ts#L35)* +*Defined in [KeyValue.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/KeyValue.ts#L35)* **Returns:** [StorageData](_storagedata_.storagedata.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_keyvalue_.keyvalueoption.md b/docs/types/classes/_keyvalue_.keyvalueoption.md index c705903234..02d9bb5075 100644 --- a/docs/types/classes/_keyvalue_.keyvalueoption.md +++ b/docs/types/classes/_keyvalue_.keyvalueoption.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [KeyValue.ts:48](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/KeyValue.ts#L48)* +*Defined in [KeyValue.ts:48](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/KeyValue.ts#L48)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getkey(): [StorageKey](_storagekey_.storagekey.md) -*Defined in [KeyValue.ts:56](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/KeyValue.ts#L56)* +*Defined in [KeyValue.ts:56](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/KeyValue.ts#L56)* **Returns:** [StorageKey](_storagekey_.storagekey.md) @@ -118,7 +118,7 @@ ___ getvalue(): [Option](_codec_option_.option.md)<[StorageData](_storagedata_.storagedata.md)> -*Defined in [KeyValue.ts:60](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/KeyValue.ts#L60)* +*Defined in [KeyValue.ts:60](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/KeyValue.ts#L60)* **Returns:** [Option](_codec_option_.option.md)<[StorageData](_storagedata_.storagedata.md)> @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -336,7 +336,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Tuple.ts#L28)* +*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Tuple.ts#L28)* **Returns:** `any` @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -398,7 +398,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Tuple.ts#L18)* +*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Tuple.ts#L18)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.callmetadata.md b/docs/types/classes/_metadata_.callmetadata.md index 1bbdce00c9..82bd29faab 100644 --- a/docs/types/classes/_metadata_.callmetadata.md +++ b/docs/types/classes/_metadata_.callmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:164](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L164)* +*Defined in [Metadata.ts:164](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L164)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getfunctions(): [Vector](_codec_vector_.vector.md)<[FunctionMetadata](_metadata_.functionmetadata.md)> -*Defined in [Metadata.ts:172](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L172)* +*Defined in [Metadata.ts:172](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L172)* **Returns:** [Vector](_codec_vector_.vector.md)<[FunctionMetadata](_metadata_.functionmetadata.md)> @@ -118,7 +118,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:176](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L176)* +*Defined in [Metadata.ts:176](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L176)* **Returns:** [Text](_text_.text.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.eventmetadata.md b/docs/types/classes/_metadata_.eventmetadata.md index bb88a75306..4d3e687509 100644 --- a/docs/types/classes/_metadata_.eventmetadata.md +++ b/docs/types/classes/_metadata_.eventmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:64](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L64)* +*Defined in [Metadata.ts:64](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L64)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getarguments(): [Vector](_codec_vector_.vector.md)<[Type](_type_.type.md)> -*Defined in [Metadata.ts:73](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L73)* +*Defined in [Metadata.ts:73](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L73)* **Returns:** [Vector](_codec_vector_.vector.md)<[Type](_type_.type.md)> @@ -105,7 +105,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata.ts:77](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L77)* +*Defined in [Metadata.ts:77](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L77)* **Returns:** [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> @@ -118,7 +118,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -129,7 +129,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:81](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L81)* +*Defined in [Metadata.ts:81](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L81)* **Returns:** [Text](_text_.text.md) @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -319,7 +319,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -358,7 +358,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -371,7 +371,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -405,7 +405,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.functionargumentmetadata.md b/docs/types/classes/_metadata_.functionargumentmetadata.md index 21fd181ed2..ab756989be 100644 --- a/docs/types/classes/_metadata_.functionargumentmetadata.md +++ b/docs/types/classes/_metadata_.functionargumentmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:120](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L120)* +*Defined in [Metadata.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L120)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:128](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L128)* +*Defined in [Metadata.ts:128](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L128)* **Returns:** [Text](_text_.text.md) @@ -118,7 +118,7 @@ ___ gettype(): [Type](_type_.type.md) -*Defined in [Metadata.ts:132](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L132)* +*Defined in [Metadata.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L132)* **Returns:** [Type](_type_.type.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.functionmetadata.md b/docs/types/classes/_metadata_.functionmetadata.md index 664a8156a4..b49df814c9 100644 --- a/docs/types/classes/_metadata_.functionmetadata.md +++ b/docs/types/classes/_metadata_.functionmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:137](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L137)* +*Defined in [Metadata.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L137)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getarguments(): [Vector](_codec_vector_.vector.md)<[FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)> -*Defined in [Metadata.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L147)* +*Defined in [Metadata.ts:147](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L147)* **Returns:** [Vector](_codec_vector_.vector.md)<[FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)> @@ -105,7 +105,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata.ts:151](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L151)* +*Defined in [Metadata.ts:151](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L151)* **Returns:** [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> @@ -118,7 +118,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -129,7 +129,7 @@ ___ getid(): [U16](_u16_.u16.md) -*Defined in [Metadata.ts:155](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L155)* +*Defined in [Metadata.ts:155](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L155)* **Returns:** [U16](_u16_.u16.md) @@ -140,7 +140,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L159)* +*Defined in [Metadata.ts:159](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L159)* **Returns:** [Text](_text_.text.md) @@ -257,7 +257,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -330,7 +330,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -343,7 +343,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -356,7 +356,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -369,7 +369,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -382,7 +382,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -416,7 +416,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.modulemetadata.md b/docs/types/classes/_metadata_.modulemetadata.md index ab4511d9a6..d8e729caa6 100644 --- a/docs/types/classes/_metadata_.modulemetadata.md +++ b/docs/types/classes/_metadata_.modulemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:181](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L181)* +*Defined in [Metadata.ts:181](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L181)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getcall(): [CallMetadata](_metadata_.callmetadata.md) -*Defined in [Metadata.ts:189](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L189)* +*Defined in [Metadata.ts:189](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L189)* **Returns:** [CallMetadata](_metadata_.callmetadata.md) @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:193](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L193)* +*Defined in [Metadata.ts:193](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L193)* **Returns:** [Text](_text_.text.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.outerdispatchcall.md b/docs/types/classes/_metadata_.outerdispatchcall.md index 0bdb725275..30847234ab 100644 --- a/docs/types/classes/_metadata_.outerdispatchcall.md +++ b/docs/types/classes/_metadata_.outerdispatchcall.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:25](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L25)* +*Defined in [Metadata.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L25)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getindex(): [U16](_u16_.u16.md) -*Defined in [Metadata.ts:34](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L34)* +*Defined in [Metadata.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L34)* **Returns:** [U16](_u16_.u16.md) @@ -118,7 +118,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:38](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L38)* +*Defined in [Metadata.ts:38](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L38)* **Returns:** [Text](_text_.text.md) @@ -129,7 +129,7 @@ ___ getprefix(): [Text](_text_.text.md) -*Defined in [Metadata.ts:42](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L42)* +*Defined in [Metadata.ts:42](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L42)* **Returns:** [Text](_text_.text.md) @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -319,7 +319,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -358,7 +358,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -371,7 +371,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -405,7 +405,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.outerdispatchmetadata.md b/docs/types/classes/_metadata_.outerdispatchmetadata.md index 032f2e1ea1..1acb4f9707 100644 --- a/docs/types/classes/_metadata_.outerdispatchmetadata.md +++ b/docs/types/classes/_metadata_.outerdispatchmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L47)* +*Defined in [Metadata.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L47)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getcalls(): [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_.outerdispatchcall.md)> -*Defined in [Metadata.ts:55](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L55)* +*Defined in [Metadata.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L55)* **Returns:** [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_.outerdispatchcall.md)> @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:59](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L59)* +*Defined in [Metadata.ts:59](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L59)* **Returns:** [Text](_text_.text.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.outereventmetadata.md b/docs/types/classes/_metadata_.outereventmetadata.md index 92b67d7f9f..c1f1496759 100644 --- a/docs/types/classes/_metadata_.outereventmetadata.md +++ b/docs/types/classes/_metadata_.outereventmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:103](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L103)* +*Defined in [Metadata.ts:103](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L103)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)> -*Defined in [Metadata.ts:111](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L111)* +*Defined in [Metadata.ts:111](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L111)* **Returns:** [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)> @@ -118,7 +118,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:115](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L115)* +*Defined in [Metadata.ts:115](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L115)* **Returns:** [Text](_text_.text.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.outereventmetadataevent.md b/docs/types/classes/_metadata_.outereventmetadataevent.md index bcd9582c06..18d16d4719 100644 --- a/docs/types/classes/_metadata_.outereventmetadataevent.md +++ b/docs/types/classes/_metadata_.outereventmetadataevent.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:86](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L86)* +*Defined in [Metadata.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L86)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[EventMetadata](_metadata_.eventmetadata.md)> -*Defined in [Metadata.ts:94](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L94)* +*Defined in [Metadata.ts:94](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L94)* **Returns:** [Vector](_codec_vector_.vector.md)<[EventMetadata](_metadata_.eventmetadata.md)> @@ -118,7 +118,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:98](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L98)* +*Defined in [Metadata.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L98)* **Returns:** [Text](_text_.text.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -336,7 +336,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Tuple.ts#L28)* +*Defined in [codec/Tuple.ts:28](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Tuple.ts#L28)* **Returns:** `any` @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -398,7 +398,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Tuple.ts#L18)* +*Defined in [codec/Tuple.ts:18](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Tuple.ts#L18)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.runtimemetadata.md b/docs/types/classes/_metadata_.runtimemetadata.md index 7668307dcd..dba280be16 100644 --- a/docs/types/classes/_metadata_.runtimemetadata.md +++ b/docs/types/classes/_metadata_.runtimemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:325](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L325)* +*Defined in [Metadata.ts:325](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L325)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getcalls(): [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_.outerdispatchcall.md)> -*Defined in [Metadata.ts:364](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L364)* +*Defined in [Metadata.ts:364](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L364)* **Returns:** [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_.outerdispatchcall.md)> @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)> -*Defined in [Metadata.ts:368](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L368)* +*Defined in [Metadata.ts:368](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L368)* **Returns:** [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)> @@ -129,7 +129,7 @@ ___ getmodules(): [Vector](_codec_vector_.vector.md)<[RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md)> -*Defined in [Metadata.ts:372](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L372)* +*Defined in [Metadata.ts:372](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L372)* **Returns:** [Vector](_codec_vector_.vector.md)<[RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md)> @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -263,7 +263,7 @@ ___ ▸ **getUniqTypes**(): `Array`<`string`> -*Defined in [Metadata.ts:377](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L377)* +*Defined in [Metadata.ts:377](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L377)* **Returns:** `Array`<`string`> @@ -330,7 +330,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -343,7 +343,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -356,7 +356,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [Metadata.ts:360](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L360)* +*Defined in [Metadata.ts:360](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L360)* **Returns:** `any` @@ -369,7 +369,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -382,7 +382,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -414,7 +414,7 @@ ___ ▸ **decodeMetadata**(value: * `string` | `Uint8Array` | `any`*): `any` | `Uint8Array` -*Defined in [Metadata.ts:334](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L334)* +*Defined in [Metadata.ts:334](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L334)* **Parameters:** @@ -433,7 +433,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.runtimemodulemetadata.md b/docs/types/classes/_metadata_.runtimemodulemetadata.md index 1d1bcd28c0..26b19671ee 100644 --- a/docs/types/classes/_metadata_.runtimemodulemetadata.md +++ b/docs/types/classes/_metadata_.runtimemodulemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:299](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L299)* +*Defined in [Metadata.ts:299](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L299)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getmodule(): [ModuleMetadata](_metadata_.modulemetadata.md) -*Defined in [Metadata.ts:308](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L308)* +*Defined in [Metadata.ts:308](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L308)* **Returns:** [ModuleMetadata](_metadata_.modulemetadata.md) @@ -118,7 +118,7 @@ ___ getprefix(): [Text](_text_.text.md) -*Defined in [Metadata.ts:312](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L312)* +*Defined in [Metadata.ts:312](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L312)* **Returns:** [Text](_text_.text.md) @@ -129,7 +129,7 @@ ___ getstorage(): [StorageMetadata](_metadata_.storagemetadata.md) | `undefined` -*Defined in [Metadata.ts:316](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L316)* +*Defined in [Metadata.ts:316](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L316)* **Returns:** [StorageMetadata](_metadata_.storagemetadata.md) | `undefined` @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -319,7 +319,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -358,7 +358,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -371,7 +371,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -405,7 +405,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.storagefunctionmetadata.md b/docs/types/classes/_metadata_.storagefunctionmetadata.md index 7926a6061e..446b69f5d9 100644 --- a/docs/types/classes/_metadata_.storagefunctionmetadata.md +++ b/docs/types/classes/_metadata_.storagefunctionmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:255](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L255)* +*Defined in [Metadata.ts:255](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L255)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata.ts:265](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L265)* +*Defined in [Metadata.ts:265](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L265)* **Returns:** [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getmodifier(): [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md) -*Defined in [Metadata.ts:273](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L273)* +*Defined in [Metadata.ts:273](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L273)* **Returns:** [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md) @@ -129,7 +129,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata.ts:269](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L269)* +*Defined in [Metadata.ts:269](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L269)* **Returns:** [Text](_text_.text.md) @@ -140,7 +140,7 @@ ___ gettype(): [StorageFunctionType](_metadata_.storagefunctiontype.md) -*Defined in [Metadata.ts:277](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L277)* +*Defined in [Metadata.ts:277](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L277)* **Returns:** [StorageFunctionType](_metadata_.storagefunctiontype.md) @@ -257,7 +257,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -330,7 +330,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -343,7 +343,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -356,7 +356,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -369,7 +369,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -382,7 +382,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -416,7 +416,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.storagefunctionmodifier.md b/docs/types/classes/_metadata_.storagefunctionmodifier.md index 407d68c5ce..c5319762f0 100644 --- a/docs/types/classes/_metadata_.storagefunctionmodifier.md +++ b/docs/types/classes/_metadata_.storagefunctionmodifier.md @@ -16,7 +16,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [Metadata.ts:198](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L198)* +*Defined in [Metadata.ts:198](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L198)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Enum.ts:44](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L44)* +*Defined in [codec/Enum.ts:41](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L41)* **Returns:** `number` @@ -72,7 +72,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Enum.ts:48](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L48)* +*Defined in [codec/Enum.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L45)* **Returns:** `any` @@ -85,7 +85,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:52](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L52)* +*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L49)* **Returns:** `number` @@ -100,7 +100,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Enum.ts:56](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L56)* +*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L53)* **Returns:** `string` @@ -115,7 +115,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Enum.ts:60](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L60)* +*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L57)* **Parameters:** @@ -130,17 +130,17 @@ ___ ## `` decodeEnum -▸ **decodeEnum**(value?: * [Enum](_codec_enum_.enum.md) | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `number`*): `number` +▸ **decodeEnum**(value?: * [Enum](_codec_enum_.enum.md) | `Uint8Array` | `number`*): `number` *Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* -*Defined in [codec/Enum.ts:32](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L32)* +*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L31)* **Parameters:** | Param | Type | Default value | | ------ | ------ | ------ | -| `Default value` value | [Enum](_codec_enum_.enum.md) | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `number`| 0 | +| `Default value` value | [Enum](_codec_enum_.enum.md) | `Uint8Array` | `number`| 0 | **Returns:** `number` diff --git a/docs/types/classes/_metadata_.storagefunctiontype.md b/docs/types/classes/_metadata_.storagefunctiontype.md index 4102e60d9e..8ded6c0965 100644 --- a/docs/types/classes/_metadata_.storagefunctiontype.md +++ b/docs/types/classes/_metadata_.storagefunctiontype.md @@ -16,7 +16,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [Metadata.ts:221](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L221)* +*Defined in [Metadata.ts:221](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L221)* **Parameters:** @@ -39,7 +39,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -51,7 +51,7 @@ ___ getasMap(): [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md) -*Defined in [Metadata.ts:233](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L233)* +*Defined in [Metadata.ts:233](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L233)* **Returns:** [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md) @@ -62,7 +62,7 @@ ___ getasType(): [Type](_type_.type.md) -*Defined in [Metadata.ts:237](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L237)* +*Defined in [Metadata.ts:237](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L237)* **Returns:** [Type](_type_.type.md) @@ -77,7 +77,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L97)* +*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L94)* **Returns:** `number` @@ -88,7 +88,7 @@ ___ getisMap(): `boolean` -*Defined in [Metadata.ts:229](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L229)* +*Defined in [Metadata.ts:229](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L229)* **Returns:** `boolean` @@ -101,7 +101,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:85](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L85)* +*Defined in [codec/EnumType.ts:82](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L82)* **Returns:** `boolean` @@ -114,7 +114,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L89)* +*Defined in [codec/EnumType.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L86)* **Returns:** `string` @@ -127,7 +127,7 @@ getvalue(): [Base](_codec_base_.base.md)< [Type](_type_.type.md) | [Storage *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:93](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L93)* +*Defined in [codec/EnumType.ts:90](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L90)* **Returns:** [Base](_codec_base_.base.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)> @@ -143,7 +143,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[setValue](_codec_enumtype_.enumtype.md#setvalue)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L98)* **Parameters:** @@ -165,7 +165,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L118)* +*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L115)* **Returns:** `any` @@ -178,7 +178,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:122](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L122)* +*Defined in [codec/EnumType.ts:119](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L119)* **Returns:** `number` @@ -191,7 +191,7 @@ ___ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [Metadata.ts:241](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L241)* +*Defined in [Metadata.ts:241](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L241)* **Returns:** `string` @@ -206,7 +206,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/EnumType.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L130)* +*Defined in [codec/EnumType.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L127)* **Parameters:** @@ -225,7 +225,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[decodeEnumType](_codec_enumtype_.enumtype.md#decodeenumtype)* -*Defined in [codec/EnumType.ts:46](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L46)* +*Defined in [codec/EnumType.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L45)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.storagefunctiontype_map.md b/docs/types/classes/_metadata_.storagefunctiontype_map.md index 0f68fb6975..d02d5f4f6f 100644 --- a/docs/types/classes/_metadata_.storagefunctiontype_map.md +++ b/docs/types/classes/_metadata_.storagefunctiontype_map.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:204](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L204)* +*Defined in [Metadata.ts:204](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L204)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getkey(): [Type](_type_.type.md) -*Defined in [Metadata.ts:212](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L212)* +*Defined in [Metadata.ts:212](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L212)* **Returns:** [Type](_type_.type.md) @@ -118,7 +118,7 @@ ___ getvalue(): [Type](_type_.type.md) -*Defined in [Metadata.ts:216](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L216)* +*Defined in [Metadata.ts:216](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L216)* **Returns:** [Type](_type_.type.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_metadata_.storagemetadata.md b/docs/types/classes/_metadata_.storagemetadata.md index 31fb229a61..08e430e76d 100644 --- a/docs/types/classes/_metadata_.storagemetadata.md +++ b/docs/types/classes/_metadata_.storagemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata.ts:282](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L282)* +*Defined in [Metadata.ts:282](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L282)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getfunctions(): [Vector](_codec_vector_.vector.md)<[StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md)> -*Defined in [Metadata.ts:290](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L290)* +*Defined in [Metadata.ts:290](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L290)* **Returns:** [Vector](_codec_vector_.vector.md)<[StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md)> @@ -118,7 +118,7 @@ ___ getprefix(): [Text](_text_.text.md) -*Defined in [Metadata.ts:294](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Metadata.ts#L294)* +*Defined in [Metadata.ts:294](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Metadata.ts#L294)* **Returns:** [Text](_text_.text.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_method_.method.md b/docs/types/classes/_method_.method.md index 0885426ac1..b334035ffb 100644 --- a/docs/types/classes/_method_.method.md +++ b/docs/types/classes/_method_.method.md @@ -29,7 +29,7 @@ Extrinsic function descriptor, as defined in [https://github.com/paritytech/wiki *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Method.ts:48](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L48)* +*Defined in [Method.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L47)* **Parameters:** @@ -63,7 +63,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -88,7 +88,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -99,7 +99,7 @@ ___ getargs(): `Array`<[Base](_codec_base_.base.md)> -*Defined in [Method.ts:172](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L172)* +*Defined in [Method.ts:169](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L169)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -110,7 +110,7 @@ ___ getargsDef(): `ArgsDef` -*Defined in [Method.ts:177](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L177)* +*Defined in [Method.ts:174](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L174)* **Returns:** `ArgsDef` @@ -121,7 +121,7 @@ ___ getcallIndex(): `Uint8Array` -*Defined in [Method.ts:181](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L181)* +*Defined in [Method.ts:178](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L178)* **Returns:** `Uint8Array` @@ -132,7 +132,7 @@ ___ getdata(): `Uint8Array` -*Defined in [Method.ts:185](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L185)* +*Defined in [Method.ts:182](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L182)* **Returns:** `Uint8Array` @@ -145,7 +145,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -156,7 +156,7 @@ ___ getmeta(): [FunctionMetadata](_metadata_.functionmetadata.md) -*Defined in [Method.ts:189](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L189)* +*Defined in [Method.ts:186](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L186)* **Returns:** [FunctionMetadata](_metadata_.functionmetadata.md) @@ -273,7 +273,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -346,7 +346,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -359,7 +359,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -372,7 +372,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -385,7 +385,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -398,7 +398,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -430,7 +430,7 @@ ___ ▸ **filterOrigin**(meta?: *[FunctionMetadata](_metadata_.functionmetadata.md)*): `Array`<[FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)> -*Defined in [Method.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L123)* +*Defined in [Method.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L120)* **Parameters:** @@ -447,7 +447,7 @@ ___ ▸ **findFunction**(callIndex: *`Uint8Array`*): `ExtrinsicFunction` -*Defined in [Method.ts:139](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L139)* +*Defined in [Method.ts:136](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L136)* **Parameters:** @@ -464,7 +464,7 @@ ___ ▸ **injectExtrinsics**(extrinsics: *`Extrinsics`*): `void` -*Defined in [Method.ts:164](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L164)* +*Defined in [Method.ts:161](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L161)* **Parameters:** @@ -483,7 +483,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftatreport.md b/docs/types/classes/_misbehaviorreport_.bftatreport.md index b042b4bd25..1bb78805cc 100644 --- a/docs/types/classes/_misbehaviorreport_.bftatreport.md +++ b/docs/types/classes/_misbehaviorreport_.bftatreport.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:28](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L28)* +*Defined in [MisbehaviorReport.ts:28](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L28)* **Parameters:** @@ -62,7 +62,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -87,7 +87,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -98,7 +98,7 @@ ___ geta(): [BftHashSignature](_bft_.bfthashsignature.md) -*Defined in [MisbehaviorReport.ts:37](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L37)* +*Defined in [MisbehaviorReport.ts:37](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L37)* **Returns:** [BftHashSignature](_bft_.bfthashsignature.md) @@ -109,7 +109,7 @@ ___ getb(): [BftHashSignature](_bft_.bfthashsignature.md) -*Defined in [MisbehaviorReport.ts:41](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L41)* +*Defined in [MisbehaviorReport.ts:41](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L41)* **Returns:** [BftHashSignature](_bft_.bfthashsignature.md) @@ -122,7 +122,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -133,7 +133,7 @@ ___ getround(): [U32](_u32_.u32.md) -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L45)* **Returns:** [U32](_u32_.u32.md) @@ -250,7 +250,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -323,7 +323,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -336,7 +336,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -375,7 +375,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -409,7 +409,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md index f178f4b05b..a6e11e01ee 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md +++ b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md @@ -27,7 +27,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:28](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L28)* +*Defined in [MisbehaviorReport.ts:28](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L28)* **Parameters:** @@ -60,7 +60,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -85,7 +85,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -98,7 +98,7 @@ geta(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* -*Defined in [MisbehaviorReport.ts:37](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L37)* +*Defined in [MisbehaviorReport.ts:37](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L37)* **Returns:** [BftHashSignature](_bft_.bfthashsignature.md) @@ -111,7 +111,7 @@ getb(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* -*Defined in [MisbehaviorReport.ts:41](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L41)* +*Defined in [MisbehaviorReport.ts:41](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L41)* **Returns:** [BftHashSignature](_bft_.bfthashsignature.md) @@ -124,7 +124,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -137,7 +137,7 @@ getround(): [U32](_u32_.u32.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L45)* **Returns:** [U32](_u32_.u32.md) @@ -254,7 +254,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -327,7 +327,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -340,7 +340,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -353,7 +353,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -379,7 +379,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md index ea1e30bdb4..0bbcf7e676 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md +++ b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md @@ -27,7 +27,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:28](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L28)* +*Defined in [MisbehaviorReport.ts:28](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L28)* **Parameters:** @@ -60,7 +60,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -85,7 +85,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -98,7 +98,7 @@ geta(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* -*Defined in [MisbehaviorReport.ts:37](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L37)* +*Defined in [MisbehaviorReport.ts:37](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L37)* **Returns:** [BftHashSignature](_bft_.bfthashsignature.md) @@ -111,7 +111,7 @@ getb(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* -*Defined in [MisbehaviorReport.ts:41](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L41)* +*Defined in [MisbehaviorReport.ts:41](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L41)* **Returns:** [BftHashSignature](_bft_.bfthashsignature.md) @@ -124,7 +124,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -137,7 +137,7 @@ getround(): [U32](_u32_.u32.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L45)* **Returns:** [U32](_u32_.u32.md) @@ -254,7 +254,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -327,7 +327,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -340,7 +340,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -353,7 +353,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -379,7 +379,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md index 25e037bfa6..51d3c903a0 100644 --- a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md +++ b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md @@ -16,7 +16,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [MisbehaviorReport.ts:58](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L58)* +*Defined in [MisbehaviorReport.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L58)* **Parameters:** @@ -39,7 +39,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -55,7 +55,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L97)* +*Defined in [codec/EnumType.ts:94](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L94)* **Returns:** `number` @@ -68,7 +68,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:85](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L85)* +*Defined in [codec/EnumType.ts:82](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L82)* **Returns:** `boolean` @@ -81,7 +81,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L89)* +*Defined in [codec/EnumType.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L86)* **Returns:** `string` @@ -94,7 +94,7 @@ getvalue(): [Base](_codec_base_.base.md)< [BftDoublePrepare](_misbehaviorreport_ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:93](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L93)* +*Defined in [codec/EnumType.ts:90](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L90)* **Returns:** [Base](_codec_base_.base.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)> @@ -110,7 +110,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[setValue](_codec_enumtype_.enumtype.md#setvalue)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L98)* **Parameters:** @@ -132,7 +132,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L118)* +*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L115)* **Returns:** `any` @@ -145,7 +145,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:122](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L122)* +*Defined in [codec/EnumType.ts:119](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L119)* **Returns:** `number` @@ -160,7 +160,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/EnumType.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L126)* +*Defined in [codec/EnumType.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L123)* **Returns:** `string` @@ -175,7 +175,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/EnumType.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L130)* +*Defined in [codec/EnumType.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L127)* **Parameters:** @@ -194,7 +194,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[decodeEnumType](_codec_enumtype_.enumtype.md#decodeenumtype)* -*Defined in [codec/EnumType.ts:46](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/EnumType.ts#L46)* +*Defined in [codec/EnumType.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/EnumType.ts#L45)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md index 351939163b..f1423a652a 100644 --- a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md +++ b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L75)* +*Defined in [MisbehaviorReport.ts:75](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L75)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getmisbehavior(): [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) -*Defined in [MisbehaviorReport.ts:85](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L85)* +*Defined in [MisbehaviorReport.ts:85](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L85)* **Returns:** [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) @@ -118,7 +118,7 @@ ___ getparentHash(): [Hash](_hash_.hash.md) -*Defined in [MisbehaviorReport.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L89)* +*Defined in [MisbehaviorReport.ts:89](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L89)* **Returns:** [Hash](_hash_.hash.md) @@ -129,7 +129,7 @@ ___ getparentNumber(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [MisbehaviorReport.ts:93](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L93)* +*Defined in [MisbehaviorReport.ts:93](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L93)* **Returns:** [BlockNumber](_blocknumber_.blocknumber.md) @@ -140,7 +140,7 @@ ___ gettarget(): [AuthorityId](_authorityid_.authorityid.md) -*Defined in [MisbehaviorReport.ts:97](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/MisbehaviorReport.ts#L97)* +*Defined in [MisbehaviorReport.ts:97](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/MisbehaviorReport.ts#L97)* **Returns:** [AuthorityId](_authorityid_.authorityid.md) @@ -257,7 +257,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -330,7 +330,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -343,7 +343,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -356,7 +356,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -369,7 +369,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -382,7 +382,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -416,7 +416,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_moment_.moment.md b/docs/types/classes/_moment_.moment.md index 31369f4aba..eb63a9aa4c 100644 --- a/docs/types/classes/_moment_.moment.md +++ b/docs/types/classes/_moment_.moment.md @@ -16,7 +16,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Moment.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Moment.ts#L19)* +*Defined in [Moment.ts:18](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Moment.ts#L18)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -50,7 +50,7 @@ ___ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) -*Defined in [Moment.ts:46](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Moment.ts#L46)* +*Defined in [Moment.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Moment.ts#L43)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -63,7 +63,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [Moment.ts:50](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Moment.ts#L50)* +*Defined in [Moment.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Moment.ts#L47)* **Returns:** `number` @@ -77,7 +77,7 @@ ___ ▸ **getTime**(): `number` -*Defined in [Moment.ts:54](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Moment.ts#L54)* +*Defined in [Moment.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Moment.ts#L51)* **Returns:** `number` @@ -88,7 +88,7 @@ ___ ▸ **toBn**(): `BN` -*Defined in [Moment.ts:74](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Moment.ts#L74)* +*Defined in [Moment.ts:71](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Moment.ts#L71)* **Returns:** `BN` @@ -99,7 +99,7 @@ ___ ▸ **toHex**(): `string` -*Defined in [Moment.ts:58](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Moment.ts#L58)* +*Defined in [Moment.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Moment.ts#L55)* **Returns:** `string` @@ -112,7 +112,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [Moment.ts:62](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Moment.ts#L62)* +*Defined in [Moment.ts:59](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Moment.ts#L59)* **Returns:** `any` @@ -123,7 +123,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [Moment.ts:78](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Moment.ts#L78)* +*Defined in [Moment.ts:75](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Moment.ts#L75)* **Returns:** `number` @@ -136,7 +136,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [Moment.ts:70](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Moment.ts#L70)* +*Defined in [Moment.ts:67](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Moment.ts#L67)* **Returns:** `string` @@ -149,7 +149,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [Moment.ts:66](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Moment.ts#L66)* +*Defined in [Moment.ts:63](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Moment.ts#L63)* **Parameters:** @@ -166,7 +166,7 @@ ___ ▸ **decodeMoment**(value: * [Moment](_moment_.moment.md) | `Date` | `AnyNumber`*): `Date` -*Defined in [Moment.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Moment.ts#L26)* +*Defined in [Moment.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Moment.ts#L25)* **Parameters:** diff --git a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md index cc6596845a..30335d660f 100644 --- a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md +++ b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md @@ -16,7 +16,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [NewAccountOutcome.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/NewAccountOutcome.ts#L9)* +*Defined in [NewAccountOutcome.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/NewAccountOutcome.ts#L9)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Enum.ts:44](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L44)* +*Defined in [codec/Enum.ts:41](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L41)* **Returns:** `number` @@ -72,7 +72,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Enum.ts:48](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L48)* +*Defined in [codec/Enum.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L45)* **Returns:** `any` @@ -85,7 +85,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:52](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L52)* +*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L49)* **Returns:** `number` @@ -100,7 +100,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Enum.ts:56](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L56)* +*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L53)* **Returns:** `string` @@ -115,7 +115,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Enum.ts:60](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L60)* +*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L57)* **Parameters:** @@ -130,17 +130,17 @@ ___ ## `` decodeEnum -▸ **decodeEnum**(value?: * [Enum](_codec_enum_.enum.md) | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `number`*): `number` +▸ **decodeEnum**(value?: * [Enum](_codec_enum_.enum.md) | `Uint8Array` | `number`*): `number` *Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* -*Defined in [codec/Enum.ts:32](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L32)* +*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L31)* **Parameters:** | Param | Type | Default value | | ------ | ------ | ------ | -| `Default value` value | [Enum](_codec_enum_.enum.md) | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `number`| 0 | +| `Default value` value | [Enum](_codec_enum_.enum.md) | `Uint8Array` | `number`| 0 | **Returns:** `number` diff --git a/docs/types/classes/_nonce_.index.md b/docs/types/classes/_nonce_.index.md index e16e8440f7..9d0af09006 100644 --- a/docs/types/classes/_nonce_.index.md +++ b/docs/types/classes/_nonce_.index.md @@ -18,7 +18,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U64.ts#L9)* +*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U64.ts#L9)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -69,7 +69,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -85,7 +85,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -104,7 +104,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -123,7 +123,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -142,7 +142,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -161,7 +161,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -180,7 +180,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -199,7 +199,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -212,7 +212,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -231,7 +231,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -250,7 +250,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -269,7 +269,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -288,7 +288,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -301,7 +301,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -316,7 +316,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -329,7 +329,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -344,7 +344,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -359,7 +359,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -378,7 +378,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_null_.null.md b/docs/types/classes/_null_.null.md index a5d6f1c690..290a3f601e 100644 --- a/docs/types/classes/_null_.null.md +++ b/docs/types/classes/_null_.null.md @@ -18,7 +18,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Null.ts:8](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Null.ts#L8)* +*Defined in [Null.ts:8](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Null.ts#L8)* **Returns:** [Null](_null_.null.md) @@ -34,7 +34,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -48,7 +48,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [Null.ts:13](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Null.ts#L13)* +*Defined in [Null.ts:13](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Null.ts#L13)* **Returns:** `number` @@ -64,7 +64,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Null.ts#L17)* +*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Null.ts#L17)* **Returns:** `any` @@ -77,7 +77,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [Null.ts:25](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Null.ts#L25)* +*Defined in [Null.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Null.ts#L25)* **Returns:** `string` @@ -90,7 +90,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [Null.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Null.ts#L21)* +*Defined in [Null.ts:21](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Null.ts#L21)* **Parameters:** diff --git a/docs/types/classes/_origin_.origin.md b/docs/types/classes/_origin_.origin.md index 4b44733a3c..e05b7063e8 100644 --- a/docs/types/classes/_origin_.origin.md +++ b/docs/types/classes/_origin_.origin.md @@ -18,7 +18,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Origin.ts:8](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Origin.ts#L8)* +*Defined in [Origin.ts:8](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Origin.ts#L8)* **Returns:** [Origin](_origin_.origin.md) @@ -34,7 +34,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L25)* +*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L25)* **Returns:** `number` @@ -64,7 +64,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L29)* +*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L29)* **Returns:** `any` @@ -77,7 +77,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L33)* +*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L33)* **Returns:** `string` @@ -90,7 +90,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L37)* +*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_parachainid_.parachainid.md b/docs/types/classes/_parachainid_.parachainid.md index 93b7e36800..bff66ec1e3 100644 --- a/docs/types/classes/_parachainid_.parachainid.md +++ b/docs/types/classes/_parachainid_.parachainid.md @@ -18,7 +18,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U64.ts#L9)* +*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U64.ts#L9)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -69,7 +69,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -85,7 +85,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -104,7 +104,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -123,7 +123,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -142,7 +142,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -161,7 +161,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -180,7 +180,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -199,7 +199,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -212,7 +212,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -231,7 +231,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -250,7 +250,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -269,7 +269,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -288,7 +288,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -301,7 +301,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -316,7 +316,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -329,7 +329,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -344,7 +344,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -359,7 +359,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -378,7 +378,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md index e15910b66e..d7e9c842eb 100644 --- a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md +++ b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md @@ -14,20 +14,20 @@ ## constructor -⊕ **new PendingExtrinsics**(Type: *`Constructor`<`T`>*, value?: * [Vector](_codec_vector_.vector.md)<`any`> | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `string` | `Array`<`any`>*): [PendingExtrinsics](_pendingextrinsics_.pendingextrinsics.md) +⊕ **new PendingExtrinsics**(Type: *`Constructor`<`T`>*, value?: * [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>*): [PendingExtrinsics](_pendingextrinsics_.pendingextrinsics.md) *Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Vector.ts:20](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L20)* +*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L19)* **Parameters:** | Param | Type | Default value | | ------ | ------ | ------ | | Type | `Constructor`<`T`> | - | -| `Default value` value | [Vector](_codec_vector_.vector.md)<`any`> | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `string` | `Array`<`any`>| [] as Array<any> | +| `Default value` value | [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>| [] as Array<any> | **Returns:** [PendingExtrinsics](_pendingextrinsics_.pendingextrinsics.md) @@ -43,7 +43,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -57,7 +57,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:68](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L68)* +*Defined in [codec/Vector.ts:65](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L65)* **Returns:** `string` @@ -72,7 +72,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Vector.ts:76](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L76)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L73)* **Returns:** `number` @@ -85,7 +85,7 @@ getlength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)* -*Defined in [codec/Vector.ts:72](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L72)* +*Defined in [codec/Vector.ts:69](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L69)* **Returns:** `number` @@ -101,7 +101,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)* -*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L82)* +*Defined in [codec/Vector.ts:79](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L79)* **Parameters:** @@ -120,7 +120,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[find](_codec_vector_.vector.md#find)* -*Defined in [codec/Vector.ts:86](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L86)* +*Defined in [codec/Vector.ts:83](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L83)* **Parameters:** @@ -139,7 +139,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[forEach](_codec_vector_.vector.md#foreach)* -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L90)* +*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L87)* **Parameters:** @@ -158,7 +158,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[get](_codec_vector_.vector.md#get)* -*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L94)* +*Defined in [codec/Vector.ts:91](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L91)* **Parameters:** @@ -177,7 +177,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)* -*Defined in [codec/Vector.ts:98](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L98)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L95)* **Type parameters:** @@ -199,7 +199,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[push](_codec_vector_.vector.md#push)* -*Defined in [codec/Vector.ts:102](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L102)* +*Defined in [codec/Vector.ts:99](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L99)* **Parameters:** @@ -218,7 +218,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[reduce](_codec_vector_.vector.md#reduce)* -*Defined in [codec/Vector.ts:106](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L106)* +*Defined in [codec/Vector.ts:103](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L103)* **Type parameters:** @@ -243,7 +243,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L110)* +*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L107)* **Returns:** `any` @@ -258,7 +258,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L129)* +*Defined in [codec/Vector.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L126)* **Returns:** `string` @@ -273,7 +273,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Vector.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L116)* +*Defined in [codec/Vector.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L113)* **Parameters:** @@ -288,11 +288,11 @@ ___ ## `` decodeVector -▸ **decodeVector**<`T`>(Type: *`Constructor`<`T`>*, value: * [Vector](_codec_vector_.vector.md)<`any`> | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `string` | `Array`<`any`>*): `Array`<`T`> +▸ **decodeVector**<`T`>(Type: *`Constructor`<`T`>*, value: * [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>*): `Array`<`T`> *Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* -*Defined in [codec/Vector.ts:30](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L30)* +*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L29)* **Type parameters:** @@ -302,7 +302,7 @@ ___ | Param | Type | | ------ | ------ | | Type | `Constructor`<`T`> | -| value | [Vector](_codec_vector_.vector.md)<`any`> | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `string` | `Array`<`any`>| +| value | [Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>| **Returns:** `Array`<`T`> @@ -315,7 +315,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:60](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Vector.ts#L60)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Vector.ts#L57)* **Type parameters:** diff --git a/docs/types/classes/_perbill_.perbill.md b/docs/types/classes/_perbill_.perbill.md index 397c76bbaa..bf113a3c36 100644 --- a/docs/types/classes/_perbill_.perbill.md +++ b/docs/types/classes/_perbill_.perbill.md @@ -18,7 +18,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U32.ts#L9)* +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U32.ts#L9)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -69,7 +69,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -85,7 +85,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -104,7 +104,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -123,7 +123,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -142,7 +142,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -161,7 +161,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -180,7 +180,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -199,7 +199,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -212,7 +212,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -231,7 +231,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -250,7 +250,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -269,7 +269,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -288,7 +288,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -301,7 +301,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -316,7 +316,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -329,7 +329,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -344,7 +344,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -359,7 +359,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -378,7 +378,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_permill_.permill.md b/docs/types/classes/_permill_.permill.md index 9187f5e461..756b515489 100644 --- a/docs/types/classes/_permill_.permill.md +++ b/docs/types/classes/_permill_.permill.md @@ -18,7 +18,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U32.ts#L9)* +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U32.ts#L9)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -69,7 +69,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -85,7 +85,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -104,7 +104,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -123,7 +123,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -142,7 +142,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -161,7 +161,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -180,7 +180,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -199,7 +199,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -212,7 +212,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -231,7 +231,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -250,7 +250,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -269,7 +269,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -288,7 +288,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -301,7 +301,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -316,7 +316,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -329,7 +329,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -344,7 +344,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -359,7 +359,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -378,7 +378,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_propindex_.propindex.md b/docs/types/classes/_propindex_.propindex.md index 2f5ebbbad7..278b92f89b 100644 --- a/docs/types/classes/_propindex_.propindex.md +++ b/docs/types/classes/_propindex_.propindex.md @@ -18,7 +18,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U32.ts#L9)* +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U32.ts#L9)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -69,7 +69,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -85,7 +85,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -104,7 +104,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -123,7 +123,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -142,7 +142,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -161,7 +161,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -180,7 +180,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -199,7 +199,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -212,7 +212,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -231,7 +231,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -250,7 +250,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -269,7 +269,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -288,7 +288,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -301,7 +301,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -316,7 +316,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -329,7 +329,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -344,7 +344,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -359,7 +359,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -378,7 +378,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_proposal_.proposal.md b/docs/types/classes/_proposal_.proposal.md index 910d5301fe..f186dd902a 100644 --- a/docs/types/classes/_proposal_.proposal.md +++ b/docs/types/classes/_proposal_.proposal.md @@ -27,7 +27,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Method.ts:48](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L48)* +*Defined in [Method.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L47)* **Parameters:** @@ -61,7 +61,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -86,7 +86,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -99,7 +99,7 @@ getargs(): `Array`<[Base](_codec_base_.base.md)> *Inherited from [Method](_method_.method.md).[args](_method_.method.md#args)* -*Defined in [Method.ts:172](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L172)* +*Defined in [Method.ts:169](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L169)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -112,7 +112,7 @@ getargsDef(): `ArgsDef` *Inherited from [Method](_method_.method.md).[argsDef](_method_.method.md#argsdef)* -*Defined in [Method.ts:177](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L177)* +*Defined in [Method.ts:174](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L174)* **Returns:** `ArgsDef` @@ -125,7 +125,7 @@ getcallIndex(): `Uint8Array` *Inherited from [Method](_method_.method.md).[callIndex](_method_.method.md#callindex)* -*Defined in [Method.ts:181](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L181)* +*Defined in [Method.ts:178](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L178)* **Returns:** `Uint8Array` @@ -138,7 +138,7 @@ getdata(): `Uint8Array` *Inherited from [Method](_method_.method.md).[data](_method_.method.md#data)* -*Defined in [Method.ts:185](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L185)* +*Defined in [Method.ts:182](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L182)* **Returns:** `Uint8Array` @@ -151,7 +151,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -164,7 +164,7 @@ getmeta(): [FunctionMetadata](_metadata_.functionmetadata.md) *Inherited from [Method](_method_.method.md).[meta](_method_.method.md#meta)* -*Defined in [Method.ts:189](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L189)* +*Defined in [Method.ts:186](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L186)* **Returns:** [FunctionMetadata](_metadata_.functionmetadata.md) @@ -281,7 +281,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -354,7 +354,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -367,7 +367,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -380,7 +380,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -393,7 +393,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -406,7 +406,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -440,7 +440,7 @@ ___ *Inherited from [Method](_method_.method.md).[filterOrigin](_method_.method.md#filterorigin)* -*Defined in [Method.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L123)* +*Defined in [Method.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L120)* **Parameters:** @@ -459,7 +459,7 @@ ___ *Inherited from [Method](_method_.method.md).[findFunction](_method_.method.md#findfunction)* -*Defined in [Method.ts:139](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L139)* +*Defined in [Method.ts:136](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L136)* **Parameters:** @@ -478,7 +478,7 @@ ___ *Inherited from [Method](_method_.method.md).[injectExtrinsics](_method_.method.md#injectextrinsics)* -*Defined in [Method.ts:164](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Method.ts#L164)* +*Defined in [Method.ts:161](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Method.ts#L161)* **Parameters:** @@ -497,7 +497,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_proposalindex_.proposalindex.md b/docs/types/classes/_proposalindex_.proposalindex.md index 56df970dfe..9861885d42 100644 --- a/docs/types/classes/_proposalindex_.proposalindex.md +++ b/docs/types/classes/_proposalindex_.proposalindex.md @@ -18,7 +18,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U32.ts#L9)* +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U32.ts#L9)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -69,7 +69,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -85,7 +85,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -104,7 +104,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -123,7 +123,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -142,7 +142,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -161,7 +161,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -180,7 +180,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -199,7 +199,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -212,7 +212,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -231,7 +231,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -250,7 +250,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -269,7 +269,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -288,7 +288,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -301,7 +301,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -316,7 +316,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -329,7 +329,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -344,7 +344,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -359,7 +359,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -378,7 +378,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_referendumindex_.referendumindex.md b/docs/types/classes/_referendumindex_.referendumindex.md index c3ca9fa8df..394cd68f44 100644 --- a/docs/types/classes/_referendumindex_.referendumindex.md +++ b/docs/types/classes/_referendumindex_.referendumindex.md @@ -18,7 +18,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U32.ts#L9)* +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U32.ts#L9)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -69,7 +69,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -85,7 +85,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -104,7 +104,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -123,7 +123,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -142,7 +142,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -161,7 +161,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -180,7 +180,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -199,7 +199,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -212,7 +212,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -231,7 +231,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -250,7 +250,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -269,7 +269,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -288,7 +288,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -301,7 +301,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -316,7 +316,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -329,7 +329,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -344,7 +344,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -359,7 +359,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -378,7 +378,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_runtimeversion_.runtimeversion.md b/docs/types/classes/_runtimeversion_.runtimeversion.md index 8fd8f378b4..bf543edce3 100644 --- a/docs/types/classes/_runtimeversion_.runtimeversion.md +++ b/docs/types/classes/_runtimeversion_.runtimeversion.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [RuntimeVersion.ts:52](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/RuntimeVersion.ts#L52)* +*Defined in [RuntimeVersion.ts:52](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/RuntimeVersion.ts#L52)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getapis(): [Vector](_codec_vector_.vector.md)<`RuntimeVersionApi`> -*Defined in [RuntimeVersion.ts:70](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/RuntimeVersion.ts#L70)* +*Defined in [RuntimeVersion.ts:70](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/RuntimeVersion.ts#L70)* **Returns:** [Vector](_codec_vector_.vector.md)<`RuntimeVersionApi`> @@ -105,7 +105,7 @@ ___ getauthoringVersion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:74](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/RuntimeVersion.ts#L74)* +*Defined in [RuntimeVersion.ts:74](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/RuntimeVersion.ts#L74)* **Returns:** [U32](_u32_.u32.md) @@ -118,7 +118,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -129,7 +129,7 @@ ___ getimplName(): [Text](_text_.text.md) -*Defined in [RuntimeVersion.ts:78](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/RuntimeVersion.ts#L78)* +*Defined in [RuntimeVersion.ts:78](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/RuntimeVersion.ts#L78)* **Returns:** [Text](_text_.text.md) @@ -140,7 +140,7 @@ ___ getimplVersion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:82](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/RuntimeVersion.ts#L82)* +*Defined in [RuntimeVersion.ts:82](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/RuntimeVersion.ts#L82)* **Returns:** [U32](_u32_.u32.md) @@ -151,7 +151,7 @@ ___ getspecName(): [Text](_text_.text.md) -*Defined in [RuntimeVersion.ts:86](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/RuntimeVersion.ts#L86)* +*Defined in [RuntimeVersion.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/RuntimeVersion.ts#L86)* **Returns:** [Text](_text_.text.md) @@ -162,7 +162,7 @@ ___ getspecVersion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:90](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/RuntimeVersion.ts#L90)* +*Defined in [RuntimeVersion.ts:90](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/RuntimeVersion.ts#L90)* **Returns:** [U32](_u32_.u32.md) @@ -279,7 +279,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -352,7 +352,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -365,7 +365,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -378,7 +378,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -391,7 +391,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -404,7 +404,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -438,7 +438,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_signature_.signature.md b/docs/types/classes/_signature_.signature.md index bb3918c577..fb5a204642 100644 --- a/docs/types/classes/_signature_.signature.md +++ b/docs/types/classes/_signature_.signature.md @@ -6,6 +6,13 @@ **↳ Signature** +# Implements + +* `Codec` + +# Indexable + +\[index: `number`\]: `number` # Constructors @@ -18,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:10](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/H512.ts#L10)* +*Defined in [H512.ts:10](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/H512.ts#L10)* **Parameters:** @@ -32,44 +39,118 @@ ___ # Properties - + -## raw +## BYTES_PER_ELEMENT -**● raw**: *`Uint8Array`* +**● BYTES_PER_ELEMENT**: *`number`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from Uint8Array.BYTES_PER_ELEMENT* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1886* + +The size in bytes of each element in the array. ___ + -# Accessors +## __@toStringTag - +**● __@toStringTag**: *"UInt8Array"* -## encodedLength +*Inherited from Uint8Array.[Symbol.toStringTag]* -getencodedLength(): `number` +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[encodedLength](_codec_u8afixed_.u8afixed.md#encodedlength)* +___ + -*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* +## buffer -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8aFixed.ts#L32)* +**● buffer**: *`ArrayBufferLike`* -**Returns:** `number` +*Inherited from Uint8Array.buffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1891* + +The ArrayBuffer instance referenced by the array. + +___ + + +## byteLength + +**● byteLength**: *`number`* + +*Inherited from Uint8Array.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1896* + +The length in bytes of the array. + +___ + + +## byteOffset + +**● byteOffset**: *`number`* + +*Inherited from Uint8Array.byteOffset* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1901* + +The offset in bytes of the array. ___ ## length -getlength(): `number` +**● length**: *`number`* -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* +*Inherited from Uint8Array.length* -*Defined in [codec/U8a.ts:31](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L31)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2000* + +The length of the array. + +___ + + +## raw + +**● raw**: *`Uint8Array`* + +*Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* + +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* + +___ + +# Accessors + + + +## bitLength + +getbitLength(): `number` + +*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* + +*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8aFixed.ts#L32)* + +**Returns:** `number` + +___ + + +## encodedLength + +getencodedLength(): `number` + +*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* + +*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L39)* **Returns:** `number` @@ -77,6 +158,550 @@ ___ # Methods + + +## __@iterator + +▸ **__@iterator**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.[Symbol.iterator]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* + +**Returns:** `IterableIterator`<`number`> + +___ + + +## copyWithin + +▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.copyWithin* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1912* + +Returns the this object after copying a section of the array identified by start and end to the same array starting at position target + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | +| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | +| `Optional` end | `undefined` | `number`| If not specified, length of the this object is used as its default value. | + +**Returns:** `this` + +___ + + +## entries + +▸ **entries**(): `IterableIterator`<[`number`, `number`]> + +*Inherited from Uint8Array.entries* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* + +Returns an array of key, value pairs for every entry in the array + +**Returns:** `IterableIterator`<[`number`, `number`]> + +___ + + +## every + +▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.every* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1922* + +Determines whether all the members of an array satisfy the specified test. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## fill + +▸ **fill**(value: *`number`*, start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.fill* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1932* + +Returns the this object after filling the section identified by start and end with value + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| value | `number` | value to fill array section with | +| `Optional` start | `undefined` | `number`| index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | +| `Optional` end | `undefined` | `number`| index to stop filling the array at. If end is negative, it is treated as length+end. | + +**Returns:** `this` + +___ + + +## filter + +▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.filter* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1941* + +Returns the elements of an array that meet the condition specified in a callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## find + +▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` | `undefined` + +*Inherited from Uint8Array.find* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1952* + +Returns the value of the first element in the array where predicate is true, and undefined otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` | `undefined` + +___ + + +## findIndex + +▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` + +*Inherited from Uint8Array.findIndex* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1963* + +Returns the index of the first element in the array where predicate is true, and -1 otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` + +___ + + +## forEach + +▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` + +*Inherited from Uint8Array.forEach* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* + +Performs the specified action for each element in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `void` + +___ + + +## includes + +▸ **includes**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `boolean` + +*Inherited from Uint8Array.includes* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* + +Determines whether an array includes a certain element, returning true or false as appropriate. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The element to search for. | +| `Optional` fromIndex | `undefined` | `number`| The position in this array at which to begin searching for searchElement. | + +**Returns:** `boolean` + +___ + + +## indexOf + +▸ **indexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.indexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1980* + +Returns the index of the first occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## join + +▸ **join**(separator?: * `undefined` | `string`*): `string` + +*Inherited from Uint8Array.join* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1987* + +Adds all the elements of an array separated by the specified separator string. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` separator | `undefined` | `string`| A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | + +**Returns:** `string` + +___ + + +## keys + +▸ **keys**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.keys* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* + +Returns an list of keys in the array + +**Returns:** `IterableIterator`<`number`> + +___ + + +## lastIndexOf + +▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.lastIndexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1995* + +Returns the index of the last occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## map + +▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.map* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2010* + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## reduce + +▸ **reduce**(callbackfn: *`function`*): `number` + +▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2022* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2023* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2035* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reduceRight + +▸ **reduceRight**(callbackfn: *`function`*): `number` + +▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2047* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2060* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reverse + +▸ **reverse**(): `Uint8Array` + +*Inherited from Uint8Array.reverse* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2065* + +Reverses the elements in an Array. + +**Returns:** `Uint8Array` + +___ + + +## set + +▸ **set**(array: *`ArrayLike`<`number`>*, offset?: * `undefined` | `number`*): `void` + +*Inherited from Uint8Array.set* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2072* + +Sets a value or an array of values. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | +| `Optional` offset | `undefined` | `number`| The index in the current array at which the values are to be written. | + +**Returns:** `void` + +___ + + +## slice + +▸ **slice**(start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.slice* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2079* + +Returns a section of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` start | `undefined` | `number`| The beginning of the specified portion of the array. | +| `Optional` end | `undefined` | `number`| The end of the specified portion of the array. | + +**Returns:** `Uint8Array` + +___ + + +## some + +▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.some* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2089* + +Determines whether the specified callback function returns true for any element of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## sort + +▸ **sort**(compareFn?: * `undefined` | `function`*): `this` + +*Inherited from Uint8Array.sort* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2096* + +Sorts an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` compareFn | `undefined` | `function`| The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | + +**Returns:** `this` + +___ + + +## subarray + +▸ **subarray**(begin: *`number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.subarray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2104* + +Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| begin | `number` | The index of the beginning of the array. | +| `Optional` end | `undefined` | `number`| The index of the end of the array. | + +**Returns:** `Uint8Array` + +___ ## toHex @@ -85,7 +710,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -98,12 +723,25 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` +___ + + +## toLocaleString + +▸ **toLocaleString**(): `string` + +*Inherited from Uint8Array.toLocaleString* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2109* + +Converts a number to a string by using the current locale. + +**Returns:** `string` + ___ @@ -113,9 +751,9 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -128,9 +766,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L47)* +*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L51)* **Parameters:** @@ -141,23 +777,19 @@ ___ **Returns:** `Uint8Array` ___ - + -## `` decodeU8a +## values -▸ **decodeU8a**(value: *`any`*): `Uint8Array` +▸ **values**(): `IterableIterator`<`number`> -*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)* +*Inherited from Uint8Array.values* -*Defined in [codec/U8a.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L21)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* -**Parameters:** +Returns an list of values in the array -| Param | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** `Uint8Array` +**Returns:** `IterableIterator`<`number`> ___ diff --git a/docs/types/classes/_signaturepayload_.signaturepayload.md b/docs/types/classes/_signaturepayload_.signaturepayload.md index 0d490da7fb..bf4908a603 100644 --- a/docs/types/classes/_signaturepayload_.signaturepayload.md +++ b/docs/types/classes/_signaturepayload_.signaturepayload.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [SignaturePayload.ts:28](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/SignaturePayload.ts#L28)* +*Defined in [SignaturePayload.ts:28](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/SignaturePayload.ts#L28)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getblockHash(): [Hash](_hash_.hash.md) -*Defined in [SignaturePayload.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/SignaturePayload.ts#L43)* +*Defined in [SignaturePayload.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/SignaturePayload.ts#L43)* **Returns:** [Hash](_hash_.hash.md) @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getera(): [ExtrinsicEra](_extrinsicera_.extrinsicera.md) -*Defined in [SignaturePayload.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/SignaturePayload.ts#L51)* +*Defined in [SignaturePayload.ts:51](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/SignaturePayload.ts#L51)* **Returns:** [ExtrinsicEra](_extrinsicera_.extrinsicera.md) @@ -129,7 +129,7 @@ ___ getisSigned(): `boolean` -*Defined in [SignaturePayload.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/SignaturePayload.ts#L39)* +*Defined in [SignaturePayload.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/SignaturePayload.ts#L39)* **Returns:** `boolean` @@ -140,7 +140,7 @@ ___ getmethod(): [Method](_method_.method.md) -*Defined in [SignaturePayload.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/SignaturePayload.ts#L47)* +*Defined in [SignaturePayload.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/SignaturePayload.ts#L47)* **Returns:** [Method](_method_.method.md) @@ -151,7 +151,7 @@ ___ getnonce(): `Nonce` -*Defined in [SignaturePayload.ts:55](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/SignaturePayload.ts#L55)* +*Defined in [SignaturePayload.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/SignaturePayload.ts#L55)* **Returns:** `Nonce` @@ -162,7 +162,7 @@ ___ getsignature(): `Uint8Array` -*Defined in [SignaturePayload.ts:59](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/SignaturePayload.ts#L59)* +*Defined in [SignaturePayload.ts:59](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/SignaturePayload.ts#L59)* **Returns:** `Uint8Array` @@ -279,7 +279,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -350,7 +350,7 @@ ___ ▸ **sign**(signerPair: *`KeyringPair`*): `Uint8Array` -*Defined in [SignaturePayload.ts:67](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/SignaturePayload.ts#L67)* +*Defined in [SignaturePayload.ts:67](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/SignaturePayload.ts#L67)* **Parameters:** @@ -369,7 +369,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -382,7 +382,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -395,7 +395,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -408,7 +408,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -421,7 +421,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -455,7 +455,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_signedblock_.signedblock.md b/docs/types/classes/_signedblock_.signedblock.md index a32626dcc3..aceb377a5a 100644 --- a/docs/types/classes/_signedblock_.signedblock.md +++ b/docs/types/classes/_signedblock_.signedblock.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [SignedBlock.ts:15](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/SignedBlock.ts#L15)* +*Defined in [SignedBlock.ts:15](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/SignedBlock.ts#L15)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getblock(): [Block](_block_.block.md) -*Defined in [SignedBlock.ts:23](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/SignedBlock.ts#L23)* +*Defined in [SignedBlock.ts:23](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/SignedBlock.ts#L23)* **Returns:** [Block](_block_.block.md) @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ getjustification(): [Justification](_bft_.justification.md) -*Defined in [SignedBlock.ts:27](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/SignedBlock.ts#L27)* +*Defined in [SignedBlock.ts:27](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/SignedBlock.ts#L27)* **Returns:** [Justification](_bft_.justification.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_storagechangeset_.storagechangeset.md b/docs/types/classes/_storagechangeset_.storagechangeset.md index 2b37ae4a80..11aadac23c 100644 --- a/docs/types/classes/_storagechangeset_.storagechangeset.md +++ b/docs/types/classes/_storagechangeset_.storagechangeset.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [StorageChangeSet.ts:20](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/StorageChangeSet.ts#L20)* +*Defined in [StorageChangeSet.ts:20](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/StorageChangeSet.ts#L20)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -94,7 +94,7 @@ ___ getchanges(): [Vector](_codec_vector_.vector.md)<[KeyValueOption](_keyvalue_.keyvalueoption.md)> -*Defined in [StorageChangeSet.ts:28](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/StorageChangeSet.ts#L28)* +*Defined in [StorageChangeSet.ts:28](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/StorageChangeSet.ts#L28)* **Returns:** [Vector](_codec_vector_.vector.md)<[KeyValueOption](_keyvalue_.keyvalueoption.md)> @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -118,7 +118,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [StorageChangeSet.ts:32](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/StorageChangeSet.ts#L32)* +*Defined in [StorageChangeSet.ts:32](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/StorageChangeSet.ts#L32)* **Returns:** [Hash](_hash_.hash.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_storagedata_.storagedata.md b/docs/types/classes/_storagedata_.storagedata.md index 2827c11bff..a705ffd5a7 100644 --- a/docs/types/classes/_storagedata_.storagedata.md +++ b/docs/types/classes/_storagedata_.storagedata.md @@ -6,6 +6,13 @@ **↳ StorageData** +# Implements + +* `Codec` + +# Indexable + +\[index: `number`\]: `number` # Constructors @@ -18,7 +25,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:14](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bytes.ts#L14)* +*Defined in [Bytes.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bytes.ts#L14)* **Parameters:** @@ -32,15 +39,91 @@ ___ # Properties + + +## BYTES_PER_ELEMENT + +**● BYTES_PER_ELEMENT**: *`number`* + +*Inherited from Uint8Array.BYTES_PER_ELEMENT* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1886* + +The size in bytes of each element in the array. + +___ + + +## __@toStringTag + +**● __@toStringTag**: *"UInt8Array"* + +*Inherited from Uint8Array.[Symbol.toStringTag]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* + +___ + + +## buffer + +**● buffer**: *`ArrayBufferLike`* + +*Inherited from Uint8Array.buffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1891* + +The ArrayBuffer instance referenced by the array. + +___ + + +## byteLength + +**● byteLength**: *`number`* + +*Inherited from Uint8Array.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1896* + +The length in bytes of the array. + +___ + + +## byteOffset + +**● byteOffset**: *`number`* + +*Inherited from Uint8Array.byteOffset* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1901* + +The offset in bytes of the array. + +___ + + +## length + +**● length**: *`number`* + +*Inherited from Uint8Array.length* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2000* + +The length of the array. + +___ ## raw **● raw**: *`Uint8Array`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* ___ @@ -56,22 +139,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bytes.ts#L43)* - -**Returns:** `number` - -___ - - -## length - -getlength(): `number` - -*Inherited from [Bytes](_bytes_.bytes.md).[length](_bytes_.bytes.md#length)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [Bytes.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bytes.ts#L39)* +*Defined in [Bytes.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bytes.ts#L39)* **Returns:** `number` @@ -79,6 +147,550 @@ ___ # Methods + + +## __@iterator + +▸ **__@iterator**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.[Symbol.iterator]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* + +**Returns:** `IterableIterator`<`number`> + +___ + + +## copyWithin + +▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.copyWithin* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1912* + +Returns the this object after copying a section of the array identified by start and end to the same array starting at position target + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | +| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | +| `Optional` end | `undefined` | `number`| If not specified, length of the this object is used as its default value. | + +**Returns:** `this` + +___ + + +## entries + +▸ **entries**(): `IterableIterator`<[`number`, `number`]> + +*Inherited from Uint8Array.entries* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* + +Returns an array of key, value pairs for every entry in the array + +**Returns:** `IterableIterator`<[`number`, `number`]> + +___ + + +## every + +▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.every* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1922* + +Determines whether all the members of an array satisfy the specified test. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## fill + +▸ **fill**(value: *`number`*, start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.fill* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1932* + +Returns the this object after filling the section identified by start and end with value + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| value | `number` | value to fill array section with | +| `Optional` start | `undefined` | `number`| index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | +| `Optional` end | `undefined` | `number`| index to stop filling the array at. If end is negative, it is treated as length+end. | + +**Returns:** `this` + +___ + + +## filter + +▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.filter* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1941* + +Returns the elements of an array that meet the condition specified in a callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## find + +▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` | `undefined` + +*Inherited from Uint8Array.find* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1952* + +Returns the value of the first element in the array where predicate is true, and undefined otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` | `undefined` + +___ + + +## findIndex + +▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` + +*Inherited from Uint8Array.findIndex* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1963* + +Returns the index of the first element in the array where predicate is true, and -1 otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` + +___ + + +## forEach + +▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` + +*Inherited from Uint8Array.forEach* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* + +Performs the specified action for each element in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `void` + +___ + + +## includes + +▸ **includes**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `boolean` + +*Inherited from Uint8Array.includes* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* + +Determines whether an array includes a certain element, returning true or false as appropriate. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The element to search for. | +| `Optional` fromIndex | `undefined` | `number`| The position in this array at which to begin searching for searchElement. | + +**Returns:** `boolean` + +___ + + +## indexOf + +▸ **indexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.indexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1980* + +Returns the index of the first occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## join + +▸ **join**(separator?: * `undefined` | `string`*): `string` + +*Inherited from Uint8Array.join* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1987* + +Adds all the elements of an array separated by the specified separator string. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` separator | `undefined` | `string`| A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | + +**Returns:** `string` + +___ + + +## keys + +▸ **keys**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.keys* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* + +Returns an list of keys in the array + +**Returns:** `IterableIterator`<`number`> + +___ + + +## lastIndexOf + +▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.lastIndexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1995* + +Returns the index of the last occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## map + +▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.map* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2010* + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## reduce + +▸ **reduce**(callbackfn: *`function`*): `number` + +▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2022* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2023* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2035* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reduceRight + +▸ **reduceRight**(callbackfn: *`function`*): `number` + +▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2047* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2060* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reverse + +▸ **reverse**(): `Uint8Array` + +*Inherited from Uint8Array.reverse* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2065* + +Reverses the elements in an Array. + +**Returns:** `Uint8Array` + +___ + + +## set + +▸ **set**(array: *`ArrayLike`<`number`>*, offset?: * `undefined` | `number`*): `void` + +*Inherited from Uint8Array.set* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2072* + +Sets a value or an array of values. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | +| `Optional` offset | `undefined` | `number`| The index in the current array at which the values are to be written. | + +**Returns:** `void` + +___ + + +## slice + +▸ **slice**(start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.slice* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2079* + +Returns a section of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` start | `undefined` | `number`| The beginning of the specified portion of the array. | +| `Optional` end | `undefined` | `number`| The end of the specified portion of the array. | + +**Returns:** `Uint8Array` + +___ + + +## some + +▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.some* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2089* + +Determines whether the specified callback function returns true for any element of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## sort + +▸ **sort**(compareFn?: * `undefined` | `function`*): `this` + +*Inherited from Uint8Array.sort* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2096* + +Sorts an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` compareFn | `undefined` | `function`| The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | + +**Returns:** `this` + +___ + + +## subarray + +▸ **subarray**(begin: *`number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.subarray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2104* + +Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| begin | `number` | The index of the beginning of the array. | +| `Optional` end | `undefined` | `number`| The index of the end of the array. | + +**Returns:** `Uint8Array` + +___ ## toHex @@ -87,7 +699,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -100,12 +712,25 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` +___ + + +## toLocaleString + +▸ **toLocaleString**(): `string` + +*Inherited from Uint8Array.toLocaleString* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2109* + +Converts a number to a string by using the current locale. + +**Returns:** `string` + ___ @@ -115,9 +740,9 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -132,7 +757,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bytes.ts#L47)* +*Defined in [Bytes.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bytes.ts#L43)* **Parameters:** @@ -143,42 +768,19 @@ ___ **Returns:** `Uint8Array` ___ - + -## `` decodeBytes +## values -▸ **decodeBytes**(value: *`AnyU8a`*): `Uint8Array` +▸ **values**(): `IterableIterator`<`number`> -*Inherited from [Bytes](_bytes_.bytes.md).[decodeBytes](_bytes_.bytes.md#decodebytes)* +*Inherited from Uint8Array.values* -*Defined in [Bytes.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bytes.ts#L19)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* -**Parameters:** +Returns an list of values in the array -| Param | Type | -| ------ | ------ | -| value | `AnyU8a` | - -**Returns:** `Uint8Array` - -___ - - -## `` decodeU8a - -▸ **decodeU8a**(value: *`any`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)* - -*Defined in [codec/U8a.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L21)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** `Uint8Array` +**Returns:** `IterableIterator`<`number`> ___ diff --git a/docs/types/classes/_storagekey_.storagekey.md b/docs/types/classes/_storagekey_.storagekey.md index 176dd0366e..6b9fa64b5b 100644 --- a/docs/types/classes/_storagekey_.storagekey.md +++ b/docs/types/classes/_storagekey_.storagekey.md @@ -6,6 +6,13 @@ **↳ StorageKey** +# Implements + +* `Codec` + +# Indexable + +\[index: `number`\]: `number` # Constructors @@ -16,7 +23,7 @@ *Overrides [Bytes](_bytes_.bytes.md).[constructor](_bytes_.bytes.md#constructor)* -*Defined in [StorageKey.ts:24](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/StorageKey.ts#L24)* +*Defined in [StorageKey.ts:23](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/StorageKey.ts#L23)* **Parameters:** @@ -30,15 +37,91 @@ ___ # Properties + + +## BYTES_PER_ELEMENT + +**● BYTES_PER_ELEMENT**: *`number`* + +*Inherited from Uint8Array.BYTES_PER_ELEMENT* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1886* + +The size in bytes of each element in the array. + +___ + + +## __@toStringTag + +**● __@toStringTag**: *"UInt8Array"* + +*Inherited from Uint8Array.[Symbol.toStringTag]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* + +___ + + +## buffer + +**● buffer**: *`ArrayBufferLike`* + +*Inherited from Uint8Array.buffer* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1891* + +The ArrayBuffer instance referenced by the array. + +___ + + +## byteLength + +**● byteLength**: *`number`* + +*Inherited from Uint8Array.byteLength* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1896* + +The length in bytes of the array. + +___ + + +## byteOffset + +**● byteOffset**: *`number`* + +*Inherited from Uint8Array.byteOffset* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1901* + +The offset in bytes of the array. + +___ + + +## length + +**● length**: *`number`* + +*Inherited from Uint8Array.length* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2000* + +The length of the array. + +___ ## raw **● raw**: *`Uint8Array`* -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* +*Inherited from [U8a](_codec_u8a_.u8a.md).[raw](_codec_u8a_.u8a.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/U8a.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L14)* ___ @@ -54,22 +137,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bytes.ts#L43)* - -**Returns:** `number` - -___ - - -## length - -getlength(): `number` - -*Inherited from [Bytes](_bytes_.bytes.md).[length](_bytes_.bytes.md#length)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [Bytes.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bytes.ts#L39)* +*Defined in [Bytes.ts:39](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bytes.ts#L39)* **Returns:** `number` @@ -80,7 +148,7 @@ ___ getoutputType(): `string` | `null` -*Defined in [StorageKey.ts:62](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/StorageKey.ts#L62)* +*Defined in [StorageKey.ts:59](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/StorageKey.ts#L59)* **Returns:** `string` | `null` @@ -88,6 +156,550 @@ ___ # Methods + + +## __@iterator + +▸ **__@iterator**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.[Symbol.iterator]* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* + +**Returns:** `IterableIterator`<`number`> + +___ + + +## copyWithin + +▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.copyWithin* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1912* + +Returns the this object after copying a section of the array identified by start and end to the same array starting at position target + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | +| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | +| `Optional` end | `undefined` | `number`| If not specified, length of the this object is used as its default value. | + +**Returns:** `this` + +___ + + +## entries + +▸ **entries**(): `IterableIterator`<[`number`, `number`]> + +*Inherited from Uint8Array.entries* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* + +Returns an array of key, value pairs for every entry in the array + +**Returns:** `IterableIterator`<[`number`, `number`]> + +___ + + +## every + +▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.every* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1922* + +Determines whether all the members of an array satisfy the specified test. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## fill + +▸ **fill**(value: *`number`*, start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `this` + +*Inherited from Uint8Array.fill* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1932* + +Returns the this object after filling the section identified by start and end with value + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| value | `number` | value to fill array section with | +| `Optional` start | `undefined` | `number`| index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | +| `Optional` end | `undefined` | `number`| index to stop filling the array at. If end is negative, it is treated as length+end. | + +**Returns:** `this` + +___ + + +## filter + +▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.filter* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1941* + +Returns the elements of an array that meet the condition specified in a callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## find + +▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` | `undefined` + +*Inherited from Uint8Array.find* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1952* + +Returns the value of the first element in the array where predicate is true, and undefined otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` | `undefined` + +___ + + +## findIndex + +▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` + +*Inherited from Uint8Array.findIndex* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1963* + +Returns the index of the first element in the array where predicate is true, and -1 otherwise. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | +| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +**Returns:** `number` + +___ + + +## forEach + +▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` + +*Inherited from Uint8Array.forEach* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* + +Performs the specified action for each element in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `void` + +___ + + +## includes + +▸ **includes**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `boolean` + +*Inherited from Uint8Array.includes* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* + +Determines whether an array includes a certain element, returning true or false as appropriate. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The element to search for. | +| `Optional` fromIndex | `undefined` | `number`| The position in this array at which to begin searching for searchElement. | + +**Returns:** `boolean` + +___ + + +## indexOf + +▸ **indexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.indexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1980* + +Returns the index of the first occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## join + +▸ **join**(separator?: * `undefined` | `string`*): `string` + +*Inherited from Uint8Array.join* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1987* + +Adds all the elements of an array separated by the specified separator string. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` separator | `undefined` | `string`| A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | + +**Returns:** `string` + +___ + + +## keys + +▸ **keys**(): `IterableIterator`<`number`> + +*Inherited from Uint8Array.keys* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* + +Returns an list of keys in the array + +**Returns:** `IterableIterator`<`number`> + +___ + + +## lastIndexOf + +▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: * `undefined` | `number`*): `number` + +*Inherited from Uint8Array.lastIndexOf* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1995* + +Returns the index of the last occurrence of a value in an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| searchElement | `number` | The value to locate in the array. | +| `Optional` fromIndex | `undefined` | `number`| The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | + +**Returns:** `number` + +___ + + +## map + +▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` + +*Inherited from Uint8Array.map* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2010* + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `Uint8Array` + +___ + + +## reduce + +▸ **reduce**(callbackfn: *`function`*): `number` + +▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2022* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2023* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduce* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2035* + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reduceRight + +▸ **reduceRight**(callbackfn: *`function`*): `number` + +▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` + +▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2047* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| callbackfn | `function` | +| initialValue | `number` | + +**Returns:** `number` + +*Inherited from Uint8Array.reduceRight* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2060* + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +**Type parameters:** + +#### U +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | +| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +**Returns:** `U` + +___ + + +## reverse + +▸ **reverse**(): `Uint8Array` + +*Inherited from Uint8Array.reverse* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2065* + +Reverses the elements in an Array. + +**Returns:** `Uint8Array` + +___ + + +## set + +▸ **set**(array: *`ArrayLike`<`number`>*, offset?: * `undefined` | `number`*): `void` + +*Inherited from Uint8Array.set* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2072* + +Sets a value or an array of values. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | +| `Optional` offset | `undefined` | `number`| The index in the current array at which the values are to be written. | + +**Returns:** `void` + +___ + + +## slice + +▸ **slice**(start?: * `undefined` | `number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.slice* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2079* + +Returns a section of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` start | `undefined` | `number`| The beginning of the specified portion of the array. | +| `Optional` end | `undefined` | `number`| The end of the specified portion of the array. | + +**Returns:** `Uint8Array` + +___ + + +## some + +▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` + +*Inherited from Uint8Array.some* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2089* + +Determines whether the specified callback function returns true for any element of an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | +| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +**Returns:** `boolean` + +___ + + +## sort + +▸ **sort**(compareFn?: * `undefined` | `function`*): `this` + +*Inherited from Uint8Array.sort* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2096* + +Sorts an array. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| `Optional` compareFn | `undefined` | `function`| The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | + +**Returns:** `this` + +___ + + +## subarray + +▸ **subarray**(begin: *`number`*, end?: * `undefined` | `number`*): `Uint8Array` + +*Inherited from Uint8Array.subarray* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2104* + +Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| begin | `number` | The index of the beginning of the array. | +| `Optional` end | `undefined` | `number`| The index of the end of the array. | + +**Returns:** `Uint8Array` + +___ ## toHex @@ -96,7 +708,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L39)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L43)* **Returns:** `string` @@ -109,12 +721,25 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L47)* **Returns:** `any` +___ + + +## toLocaleString + +▸ **toLocaleString**(): `string` + +*Inherited from Uint8Array.toLocaleString* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2109* + +Converts a number to a string by using the current locale. + +**Returns:** `string` + ___ @@ -124,9 +749,9 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* +*Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:51](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L51)* +*Defined in [codec/U8a.ts:55](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/U8a.ts#L55)* **Returns:** `string` @@ -141,7 +766,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:47](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bytes.ts#L47)* +*Defined in [Bytes.ts:43](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bytes.ts#L43)* **Parameters:** @@ -152,23 +777,19 @@ ___ **Returns:** `Uint8Array` ___ - + -## `` decodeBytes +## values -▸ **decodeBytes**(value: *`AnyU8a`*): `Uint8Array` +▸ **values**(): `IterableIterator`<`number`> -*Inherited from [Bytes](_bytes_.bytes.md).[decodeBytes](_bytes_.bytes.md#decodebytes)* +*Inherited from Uint8Array.values* -*Defined in [Bytes.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bytes.ts#L19)* +*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* -**Parameters:** +Returns an list of values in the array -| Param | Type | -| ------ | ------ | -| value | `AnyU8a` | - -**Returns:** `Uint8Array` +**Returns:** `IterableIterator`<`number`> ___ @@ -177,7 +798,7 @@ ___ ▸ **decodeStorageKey**(value: * `AnyU8a` | [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): `Uint8Array` -*Defined in [StorageKey.ts:32](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/StorageKey.ts#L32)* +*Defined in [StorageKey.ts:31](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/StorageKey.ts#L31)* **Parameters:** @@ -187,25 +808,6 @@ ___ **Returns:** `Uint8Array` -___ - - -## `` decodeU8a - -▸ **decodeU8a**(value: *`any`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)* - -*Defined in [codec/U8a.ts:21](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/U8a.ts#L21)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** `Uint8Array` - ___ @@ -213,7 +815,7 @@ ___ ▸ **getType**(value: * [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): `string` | `null` -*Defined in [StorageKey.ts:48](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/StorageKey.ts#L48)* +*Defined in [StorageKey.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/StorageKey.ts#L45)* **Parameters:** diff --git a/docs/types/classes/_text_.text.md b/docs/types/classes/_text_.text.md index da00b70aae..8fb322613e 100644 --- a/docs/types/classes/_text_.text.md +++ b/docs/types/classes/_text_.text.md @@ -18,7 +18,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Text.ts:20](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Text.ts#L20)* +*Defined in [Text.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Text.ts#L19)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [Text.ts:49](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Text.ts#L49)* +*Defined in [Text.ts:46](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Text.ts#L46)* **Returns:** `number` @@ -65,7 +65,7 @@ ___ getlength(): `number` -*Defined in [Text.ts:45](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Text.ts#L45)* +*Defined in [Text.ts:42](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Text.ts#L42)* **Returns:** `number` @@ -81,7 +81,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [Text.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Text.ts#L53)* +*Defined in [Text.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Text.ts#L50)* **Returns:** `any` @@ -94,7 +94,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [Text.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Text.ts#L57)* +*Defined in [Text.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Text.ts#L54)* **Returns:** `string` @@ -107,7 +107,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [Text.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Text.ts#L61)* +*Defined in [Text.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Text.ts#L58)* **Parameters:** @@ -124,7 +124,7 @@ ___ ▸ **decodeText**(value: * [Text](_text_.text.md) | `string` | `AnyU8a` | `object`*): `string` -*Defined in [Text.ts:27](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Text.ts#L27)* +*Defined in [Text.ts:26](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Text.ts#L26)* **Parameters:** diff --git a/docs/types/classes/_type_.type.md b/docs/types/classes/_type_.type.md index 33edd983df..2ca4bf1416 100644 --- a/docs/types/classes/_type_.type.md +++ b/docs/types/classes/_type_.type.md @@ -16,7 +16,7 @@ *Overrides [Text](_text_.text.md).[constructor](_text_.text.md#constructor)* -*Defined in [Type.ts:16](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Type.ts#L16)* +*Defined in [Type.ts:16](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Type.ts#L16)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [Text.ts:49](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Text.ts#L49)* +*Defined in [Text.ts:46](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Text.ts#L46)* **Returns:** `number` @@ -67,7 +67,7 @@ getlength(): `number` *Overrides [Text](_text_.text.md).[length](_text_.text.md#length)* -*Defined in [Type.ts:27](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Type.ts#L27)* +*Defined in [Type.ts:27](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Type.ts#L27)* **Returns:** `number` @@ -85,7 +85,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [Text.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Text.ts#L53)* +*Defined in [Text.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Text.ts#L50)* **Returns:** `any` @@ -100,7 +100,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [Text.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Text.ts#L57)* +*Defined in [Text.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Text.ts#L54)* **Returns:** `string` @@ -113,7 +113,7 @@ ___ *Overrides [Text](_text_.text.md).[toU8a](_text_.text.md#tou8a)* -*Defined in [Type.ts:34](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Type.ts#L34)* +*Defined in [Type.ts:34](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Type.ts#L34)* **Parameters:** @@ -132,7 +132,7 @@ ___ *Inherited from [Text](_text_.text.md).[decodeText](_text_.text.md#decodetext)* -*Defined in [Text.ts:27](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Text.ts#L27)* +*Defined in [Text.ts:26](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Text.ts#L26)* **Parameters:** diff --git a/docs/types/classes/_u128_.u128.md b/docs/types/classes/_u128_.u128.md index 586e02ab0c..a77be3c2d8 100644 --- a/docs/types/classes/_u128_.u128.md +++ b/docs/types/classes/_u128_.u128.md @@ -18,7 +18,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U128.ts#L9)* +*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U128.ts#L9)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -69,7 +69,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -85,7 +85,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -104,7 +104,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -123,7 +123,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -142,7 +142,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -161,7 +161,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -180,7 +180,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -199,7 +199,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -212,7 +212,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -231,7 +231,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -250,7 +250,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -269,7 +269,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -288,7 +288,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -301,7 +301,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -316,7 +316,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -329,7 +329,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -344,7 +344,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -359,7 +359,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -378,7 +378,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_u16_.u16.md b/docs/types/classes/_u16_.u16.md index e87fa4fff2..023f19f7b9 100644 --- a/docs/types/classes/_u16_.u16.md +++ b/docs/types/classes/_u16_.u16.md @@ -16,7 +16,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U16.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U16.ts#L9)* +*Defined in [U16.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U16.ts#L9)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -52,7 +52,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -67,7 +67,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -83,7 +83,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -102,7 +102,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -121,7 +121,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -140,7 +140,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -159,7 +159,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -178,7 +178,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -197,7 +197,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -210,7 +210,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -229,7 +229,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -248,7 +248,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -267,7 +267,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -286,7 +286,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -299,7 +299,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -314,7 +314,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -327,7 +327,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -342,7 +342,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -357,7 +357,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -376,7 +376,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_u256_.u256.md b/docs/types/classes/_u256_.u256.md index e7093a22f4..37595a02e6 100644 --- a/docs/types/classes/_u256_.u256.md +++ b/docs/types/classes/_u256_.u256.md @@ -16,7 +16,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U256.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U256.ts#L9)* +*Defined in [U256.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U256.ts#L9)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -52,7 +52,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -67,7 +67,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -83,7 +83,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -102,7 +102,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -121,7 +121,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -140,7 +140,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -159,7 +159,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -178,7 +178,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -197,7 +197,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -210,7 +210,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -229,7 +229,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -248,7 +248,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -267,7 +267,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -286,7 +286,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -299,7 +299,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -314,7 +314,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -327,7 +327,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -342,7 +342,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -357,7 +357,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -376,7 +376,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_u32_.u32.md b/docs/types/classes/_u32_.u32.md index 35883e0927..9ff625dff6 100644 --- a/docs/types/classes/_u32_.u32.md +++ b/docs/types/classes/_u32_.u32.md @@ -30,7 +30,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U32.ts#L9)* +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U32.ts#L9)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -66,7 +66,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -81,7 +81,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -97,7 +97,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -116,7 +116,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -135,7 +135,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -154,7 +154,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -173,7 +173,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -192,7 +192,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -211,7 +211,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -224,7 +224,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -243,7 +243,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -262,7 +262,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -281,7 +281,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -300,7 +300,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -313,7 +313,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -328,7 +328,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -341,7 +341,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -356,7 +356,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -371,7 +371,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -390,7 +390,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_u64_.u64.md b/docs/types/classes/_u64_.u64.md index 02cb411a5e..41373816fd 100644 --- a/docs/types/classes/_u64_.u64.md +++ b/docs/types/classes/_u64_.u64.md @@ -24,7 +24,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U64.ts#L9)* +*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U64.ts#L9)* **Parameters:** @@ -46,7 +46,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -60,7 +60,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -75,7 +75,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -91,7 +91,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -110,7 +110,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -129,7 +129,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -148,7 +148,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -167,7 +167,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -186,7 +186,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -205,7 +205,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -218,7 +218,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -237,7 +237,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -256,7 +256,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -275,7 +275,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -294,7 +294,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -307,7 +307,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -322,7 +322,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -335,7 +335,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -350,7 +350,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -365,7 +365,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -384,7 +384,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_u8_.u8.md b/docs/types/classes/_u8_.u8.md index 6bffdc2e71..57ade17bdd 100644 --- a/docs/types/classes/_u8_.u8.md +++ b/docs/types/classes/_u8_.u8.md @@ -16,7 +16,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U8.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U8.ts#L9)* +*Defined in [U8.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U8.ts#L9)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -52,7 +52,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -67,7 +67,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -83,7 +83,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -102,7 +102,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -121,7 +121,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -140,7 +140,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -159,7 +159,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -178,7 +178,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -197,7 +197,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -210,7 +210,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -229,7 +229,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -248,7 +248,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -267,7 +267,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -286,7 +286,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -299,7 +299,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -314,7 +314,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -327,7 +327,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -342,7 +342,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -357,7 +357,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -376,7 +376,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_validatorprefs_.validatorprefs.md b/docs/types/classes/_validatorprefs_.validatorprefs.md index da3f6db4fd..3292f4f7b6 100644 --- a/docs/types/classes/_validatorprefs_.validatorprefs.md +++ b/docs/types/classes/_validatorprefs_.validatorprefs.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [ValidatorPrefs.ts:17](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ValidatorPrefs.ts#L17)* +*Defined in [ValidatorPrefs.ts:17](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ValidatorPrefs.ts#L17)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[raw](_codec_struct_.struct.md#raw)* -*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L26)* +*Defined in [codec/Struct.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L25)* ___ @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L126)* +*Defined in [codec/Struct.ts:123](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L123)* **Returns:** `E` @@ -96,7 +96,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L130)* +*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L127)* **Returns:** `number` @@ -107,7 +107,7 @@ ___ getunstakeThreshold(): [U32](_u32_.u32.md) -*Defined in [ValidatorPrefs.ts:25](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ValidatorPrefs.ts#L25)* +*Defined in [ValidatorPrefs.ts:25](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ValidatorPrefs.ts#L25)* **Returns:** [U32](_u32_.u32.md) @@ -118,7 +118,7 @@ ___ getvalidatorPayment(): [Balance](_balance_.balance.md) -*Defined in [ValidatorPrefs.ts:29](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/ValidatorPrefs.ts#L29)* +*Defined in [ValidatorPrefs.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/ValidatorPrefs.ts#L29)* **Returns:** [Balance](_balance_.balance.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L136)* +*Defined in [codec/Struct.ts:133](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L133)* **Parameters:** @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L140)* +*Defined in [codec/Struct.ts:137](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L137)* **Returns:** `Array`<[Base](_codec_base_.base.md)> @@ -321,7 +321,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:144](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L144)* +*Defined in [codec/Struct.ts:141](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L141)* **Returns:** `string` @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L148)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L145)* **Returns:** `any` @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:156](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L156)* **Returns:** `string` @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L163)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L160)* **Parameters:** @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Struct.ts#L116)* +*Defined in [codec/Struct.ts:113](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Struct.ts#L113)* **Type parameters:** diff --git a/docs/types/classes/_voteindex_.voteindex.md b/docs/types/classes/_voteindex_.voteindex.md index 2ef046e30e..875ad83bd5 100644 --- a/docs/types/classes/_voteindex_.voteindex.md +++ b/docs/types/classes/_voteindex_.voteindex.md @@ -18,7 +18,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/U32.ts#L9)* +*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/U32.ts#L9)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getbitLength(): [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) *Inherited from [UInt](_codec_uint_.uint.md).[bitLength](_codec_uint_.uint.md#bitlength)* -*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L53)* +*Defined in [codec/UInt.ts:50](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L50)* **Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) @@ -69,7 +69,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L57)* +*Defined in [codec/UInt.ts:54](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L54)* **Returns:** `number` @@ -85,7 +85,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L89)* +*Defined in [codec/UInt.ts:86](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L86)* **Parameters:** @@ -104,7 +104,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* -*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L95)* +*Defined in [codec/UInt.ts:92](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L92)* **Parameters:** @@ -123,7 +123,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* -*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L101)* +*Defined in [codec/UInt.ts:98](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L98)* **Parameters:** @@ -142,7 +142,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)* -*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L107)* +*Defined in [codec/UInt.ts:104](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L104)* **Parameters:** @@ -161,7 +161,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* -*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L129)* +*Defined in [codec/UInt.ts:126](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L126)* **Parameters:** @@ -180,7 +180,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* -*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L135)* +*Defined in [codec/UInt.ts:132](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L132)* **Parameters:** @@ -199,7 +199,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* -*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L113)* +*Defined in [codec/UInt.ts:110](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L110)* **Returns:** `boolean` @@ -212,7 +212,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L117)* +*Defined in [codec/UInt.ts:114](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L114)* **Parameters:** @@ -231,7 +231,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* -*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L123)* +*Defined in [codec/UInt.ts:120](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L120)* **Parameters:** @@ -250,7 +250,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* -*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L141)* +*Defined in [codec/UInt.ts:138](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L138)* **Parameters:** @@ -269,7 +269,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* -*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L147)* +*Defined in [codec/UInt.ts:144](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L144)* **Parameters:** @@ -288,7 +288,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* -*Defined in [codec/UInt.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L79)* +*Defined in [codec/UInt.ts:76](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L76)* **Returns:** `BN` @@ -301,7 +301,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L61)* +*Defined in [codec/UInt.ts:58](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L58)* **Returns:** `string` @@ -316,7 +316,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L65)* +*Defined in [codec/UInt.ts:62](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L62)* **Returns:** `any` @@ -329,7 +329,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* -*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L83)* +*Defined in [codec/UInt.ts:80](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L80)* **Returns:** `number` @@ -344,7 +344,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L75)* +*Defined in [codec/UInt.ts:72](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L72)* **Returns:** `string` @@ -359,7 +359,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L71)* +*Defined in [codec/UInt.ts:68](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L68)* **Parameters:** @@ -378,7 +378,7 @@ ___ *Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:35](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L35)* **Parameters:** diff --git a/docs/types/classes/_votethreshold_.votethreshold.md b/docs/types/classes/_votethreshold_.votethreshold.md index f9c5f3eef5..40241c8ceb 100644 --- a/docs/types/classes/_votethreshold_.votethreshold.md +++ b/docs/types/classes/_votethreshold_.votethreshold.md @@ -16,7 +16,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [VoteThreshold.ts:9](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/VoteThreshold.ts#L9)* +*Defined in [VoteThreshold.ts:9](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/VoteThreshold.ts#L9)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L19)* +*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L19)* ___ @@ -54,7 +54,7 @@ getencodedLength(): `number` *Overrides [Base](_codec_base_.base.md).[encodedLength](_codec_base_.base.md#encodedlength)* -*Defined in [codec/Enum.ts:44](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L44)* +*Defined in [codec/Enum.ts:41](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L41)* **Returns:** `number` @@ -72,7 +72,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* -*Defined in [codec/Enum.ts:48](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L48)* +*Defined in [codec/Enum.ts:45](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L45)* **Returns:** `any` @@ -85,7 +85,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:52](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L52)* +*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L49)* **Returns:** `number` @@ -100,7 +100,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* -*Defined in [codec/Enum.ts:56](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L56)* +*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L53)* **Returns:** `string` @@ -115,7 +115,7 @@ ___ *Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* -*Defined in [codec/Enum.ts:60](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L60)* +*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L57)* **Parameters:** @@ -130,17 +130,17 @@ ___ ## `` decodeEnum -▸ **decodeEnum**(value?: * [Enum](_codec_enum_.enum.md) | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `number`*): `number` +▸ **decodeEnum**(value?: * [Enum](_codec_enum_.enum.md) | `Uint8Array` | `number`*): `number` *Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* -*Defined in [codec/Enum.ts:32](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Enum.ts#L32)* +*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Enum.ts#L31)* **Parameters:** | Param | Type | Default value | | ------ | ------ | ------ | -| `Default value` value | [Enum](_codec_enum_.enum.md) | [U8a](_codec_u8a_.u8a.md) | `Uint8Array` | `number`| 0 | +| `Default value` value | [Enum](_codec_enum_.enum.md) | `Uint8Array` | `number`| 0 | **Returns:** `number` diff --git a/docs/types/enums/_codec_createtype_.typedefinfo.md b/docs/types/enums/_codec_createtype_.typedefinfo.md index 639529e96e..25a7651ecf 100644 --- a/docs/types/enums/_codec_createtype_.typedefinfo.md +++ b/docs/types/enums/_codec_createtype_.typedefinfo.md @@ -19,7 +19,7 @@ **Compact**: -*Defined in [codec/createType.ts:16](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/createType.ts#L16)* +*Defined in [codec/createType.ts:16](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/createType.ts#L16)* ___ @@ -28,7 +28,7 @@ ___ **Plain**: -*Defined in [codec/createType.ts:17](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/createType.ts#L17)* +*Defined in [codec/createType.ts:17](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/createType.ts#L17)* ___ @@ -37,7 +37,7 @@ ___ **Tuple**: -*Defined in [codec/createType.ts:18](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/createType.ts#L18)* +*Defined in [codec/createType.ts:18](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/createType.ts#L18)* ___ @@ -46,7 +46,7 @@ ___ **Vector**: -*Defined in [codec/createType.ts:19](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/createType.ts#L19)* +*Defined in [codec/createType.ts:19](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/createType.ts#L19)* ___ diff --git a/docs/types/interfaces/_storagekey_.storagefunction.md b/docs/types/interfaces/_storagekey_.storagefunction.md index 81d6ca6aed..0e4f18daa4 100644 --- a/docs/types/interfaces/_storagekey_.storagefunction.md +++ b/docs/types/interfaces/_storagekey_.storagefunction.md @@ -7,7 +7,7 @@ # Callable ▸ **__call**(arg?: *`any`*): `Uint8Array` -*Defined in [StorageKey.ts:13](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/StorageKey.ts#L13)* +*Defined in [StorageKey.ts:12](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/StorageKey.ts#L12)* **Parameters:** @@ -25,7 +25,7 @@ **● meta**: *[StorageFunctionMetadata](../classes/_metadata_.storagefunctionmetadata.md)* -*Defined in [StorageKey.ts:15](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/StorageKey.ts#L15)* +*Defined in [StorageKey.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/StorageKey.ts#L14)* ___ @@ -34,7 +34,7 @@ ___ **● method**: *`string`* -*Defined in [StorageKey.ts:16](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/StorageKey.ts#L16)* +*Defined in [StorageKey.ts:15](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/StorageKey.ts#L15)* ___ @@ -43,7 +43,7 @@ ___ **● section**: *`string`* -*Defined in [StorageKey.ts:17](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/StorageKey.ts#L17)* +*Defined in [StorageKey.ts:16](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/StorageKey.ts#L16)* ___ @@ -52,7 +52,7 @@ ___ **● toJSON**: *`function`* -*Defined in [StorageKey.ts:18](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/StorageKey.ts#L18)* +*Defined in [StorageKey.ts:17](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/StorageKey.ts#L17)* #### Type declaration ▸(): `any` diff --git a/docs/types/modules/_accountindex_.md b/docs/types/modules/_accountindex_.md index 1c90d274c7..791588a4dd 100644 --- a/docs/types/modules/_accountindex_.md +++ b/docs/types/modules/_accountindex_.md @@ -20,7 +20,7 @@ **● ENUMSET_SIZE**: *`BN`* = new BN(64) -*Defined in [AccountIndex.ts:14](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/AccountIndex.ts#L14)* +*Defined in [AccountIndex.ts:13](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/AccountIndex.ts#L13)* ___ diff --git a/docs/types/modules/_address_.md b/docs/types/modules/_address_.md index 7ffff71be8..7a523ce942 100644 --- a/docs/types/modules/_address_.md +++ b/docs/types/modules/_address_.md @@ -20,7 +20,7 @@ **● ACCOUNT_ID_PREFIX**: *`Uint8Array`* = new Uint8Array([0xff]) -*Defined in [Address.ts:16](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Address.ts#L16)* +*Defined in [Address.ts:15](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Address.ts#L15)* ___ diff --git a/docs/types/modules/_bft_.md b/docs/types/modules/_bft_.md index c966a8c13a..2e2f98278a 100644 --- a/docs/types/modules/_bft_.md +++ b/docs/types/modules/_bft_.md @@ -24,7 +24,7 @@ **Ƭ BftAuthoritySignatureValue**: *`object`* -*Defined in [Bft.ts:16](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bft.ts#L16)* +*Defined in [Bft.ts:16](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bft.ts#L16)* #### Type declaration @@ -35,7 +35,7 @@ ___ **Ƭ BftHashSignatureValue**: *`object`* -*Defined in [Bft.ts:40](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bft.ts#L40)* +*Defined in [Bft.ts:40](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bft.ts#L40)* #### Type declaration @@ -46,7 +46,7 @@ ___ **Ƭ JustificationValue**: *`object`* -*Defined in [Bft.ts:64](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Bft.ts#L64)* +*Defined in [Bft.ts:64](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Bft.ts#L64)* #### Type declaration diff --git a/docs/types/modules/_block_.md b/docs/types/modules/_block_.md index 192de03400..1473df33a8 100644 --- a/docs/types/modules/_block_.md +++ b/docs/types/modules/_block_.md @@ -20,7 +20,7 @@ **Ƭ BlockValue**: *`object`* -*Defined in [Block.ts:15](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Block.ts#L15)* +*Defined in [Block.ts:15](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Block.ts#L15)* #### Type declaration diff --git a/docs/types/modules/_codec_base_.md b/docs/types/modules/_codec_base_.md index bd0cc98a27..0c9893536b 100644 --- a/docs/types/modules/_codec_base_.md +++ b/docs/types/modules/_codec_base_.md @@ -20,7 +20,7 @@ **● l**: *`object`* = logger('codec') -*Defined in [codec/Base.ts:7](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Base.ts#L7)* +*Defined in [codec/Base.ts:7](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Base.ts#L7)* #### Type declaration diff --git a/docs/types/modules/_codec_compact_.md b/docs/types/modules/_codec_compact_.md index c6fd27129c..f8b51d2ec0 100644 --- a/docs/types/modules/_codec_compact_.md +++ b/docs/types/modules/_codec_compact_.md @@ -20,7 +20,7 @@ **● DEFAULT_LENGTH_BITS**: *`32`* = 32 -*Defined in [codec/Compact.ts:14](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/Compact.ts#L14)* +*Defined in [codec/Compact.ts:13](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/Compact.ts#L13)* ___ diff --git a/docs/types/modules/_codec_createtype_.md b/docs/types/modules/_codec_createtype_.md index d01695de33..d11cd66b92 100644 --- a/docs/types/modules/_codec_createtype_.md +++ b/docs/types/modules/_codec_createtype_.md @@ -27,7 +27,7 @@ **Ƭ TypeDef**: *`object`* -*Defined in [codec/createType.ts:22](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/createType.ts#L22)* +*Defined in [codec/createType.ts:22](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/createType.ts#L22)* #### Type declaration @@ -41,7 +41,7 @@ ___ ▸ **createType**(type: * [Text](../classes/_text_.text.md) | `string`*, value?: *`any`*): [Base](../classes/_codec_base_.base.md) -*Defined in [codec/createType.ts:158](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/createType.ts#L158)* +*Defined in [codec/createType.ts:158](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/createType.ts#L158)* **Parameters:** @@ -59,7 +59,7 @@ ___ ▸ **getTypeClass**(value: *[TypeDef](_codec_createtype_.md#typedef)*): `Constructor` -*Defined in [codec/createType.ts:118](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/createType.ts#L118)* +*Defined in [codec/createType.ts:118](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/createType.ts#L118)* **Parameters:** @@ -76,7 +76,7 @@ ___ ▸ **getTypeDef**(_type: * [Text](../classes/_text_.text.md) | `string`*): [TypeDef](_codec_createtype_.md#typedef) -*Defined in [codec/createType.ts:79](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/createType.ts#L79)* +*Defined in [codec/createType.ts:79](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/createType.ts#L79)* **Parameters:** @@ -93,7 +93,7 @@ ___ ▸ **typeSplit**(type: *`string`*): `Array`<`string`> -*Defined in [codec/createType.ts:29](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/createType.ts#L29)* +*Defined in [codec/createType.ts:29](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/createType.ts#L29)* **Parameters:** diff --git a/docs/types/modules/_codec_u8a_spec_.md b/docs/types/modules/_codec_u8a_spec_.md new file mode 100644 index 0000000000..139597f9cb --- /dev/null +++ b/docs/types/modules/_codec_u8a_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/types/modules/_codec_u8afixed_spec_.md b/docs/types/modules/_codec_u8afixed_spec_.md new file mode 100644 index 0000000000..139597f9cb --- /dev/null +++ b/docs/types/modules/_codec_u8afixed_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/types/modules/_codec_uint_.md b/docs/types/modules/_codec_uint_.md index 31a4b361d6..21e37927f0 100644 --- a/docs/types/modules/_codec_uint_.md +++ b/docs/types/modules/_codec_uint_.md @@ -25,7 +25,7 @@ **Ƭ UIntBitLength**: * `8` | `16` | `32` | `64` | `128` | `256` * -*Defined in [codec/UInt.ts:13](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L13)* +*Defined in [codec/UInt.ts:12](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L12)* ___ @@ -37,7 +37,7 @@ ___ **● DEFAULT_UINT_BITS**: *`64`* = 64 -*Defined in [codec/UInt.ts:15](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/codec/UInt.ts#L15)* +*Defined in [codec/UInt.ts:14](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/codec/UInt.ts#L14)* ___ diff --git a/docs/types/modules/_header_.md b/docs/types/modules/_header_.md index e21c73104c..d9f8e2ee30 100644 --- a/docs/types/modules/_header_.md +++ b/docs/types/modules/_header_.md @@ -20,7 +20,7 @@ **Ƭ HeaderValue**: *`object`* -*Defined in [Header.ts:17](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/Header.ts#L17)* +*Defined in [Header.ts:17](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/Header.ts#L17)* #### Type declaration diff --git a/docs/types/modules/_keyvalue_.md b/docs/types/modules/_keyvalue_.md index 2bb0a6a64f..6dbf1454e8 100644 --- a/docs/types/modules/_keyvalue_.md +++ b/docs/types/modules/_keyvalue_.md @@ -21,7 +21,7 @@ **Ƭ KeyValueOptionValue**: *`object`* -*Defined in [KeyValue.ts:40](https://github.com/polkadot-js/api/blob/de284fb/packages/types/src/KeyValue.ts#L40)* +*Defined in [KeyValue.ts:40](https://github.com/polkadot-js/api/blob/73710b7/packages/types/src/KeyValue.ts#L40)* #### Type declaration diff --git a/lerna.json b/lerna.json index ab7808deab..f1fbaae0d9 100644 --- a/lerna.json +++ b/lerna.json @@ -9,5 +9,5 @@ "packages": [ "packages/*" ], - "version": "0.31.111" + "version": "0.31.112" } diff --git a/package.json b/package.json index 147d15c7e6..d69caa62a6 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "0.31.111", + "version": "0.31.112", "private": true, "engines": { "node": "^10.13.0", diff --git a/packages/api-observable/package.json b/packages/api-observable/package.json index b5d21ba8c8..594bb40fa7 100644 --- a/packages/api-observable/package.json +++ b/packages/api-observable/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api-observable", - "version": "0.31.111", + "version": "0.31.112", "description": "An Observable wrapper around the Polkadot JS API", "main": "index.js", "keywords": [ @@ -30,10 +30,10 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-rx#readme", "dependencies": { "@babel/runtime": "^7.1.2", - "@polkadot/extrinsics": "^0.31.111", - "@polkadot/rpc-core": "^0.31.111", - "@polkadot/rpc-provider": "^0.31.111", - "@polkadot/storage": "^0.31.111", + "@polkadot/extrinsics": "^0.31.112", + "@polkadot/rpc-core": "^0.31.112", + "@polkadot/rpc-provider": "^0.31.112", + "@polkadot/storage": "^0.31.112", "@types/rx": "^4.1.1", "rxjs": "^6.3.3" } diff --git a/packages/api/package.json b/packages/api/package.json index e5d49ff46e..efb756a227 100644 --- a/packages/api/package.json +++ b/packages/api/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api", - "version": "0.31.111", + "version": "0.31.112", "description": "An RxJS wrapper around the Polkadot JS RPC", "main": "index.js", "keywords": [ @@ -30,10 +30,10 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api#readme", "dependencies": { "@babel/runtime": "^7.1.2", - "@polkadot/extrinsics": "^0.31.111", - "@polkadot/rpc-provider": "^0.31.111", - "@polkadot/rpc-rx": "^0.31.111", - "@polkadot/storage": "^0.31.111", + "@polkadot/extrinsics": "^0.31.112", + "@polkadot/rpc-provider": "^0.31.112", + "@polkadot/rpc-rx": "^0.31.112", + "@polkadot/storage": "^0.31.112", "@types/rx": "^4.1.1", "rxjs": "^6.3.3" } diff --git a/packages/rpc-core/package.json b/packages/rpc-core/package.json index 4ce76c2fba..b9106d8bc8 100644 --- a/packages/rpc-core/package.json +++ b/packages/rpc-core/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-core", - "version": "0.31.111", + "version": "0.31.112", "description": "A JavaScript wrapper for the Polkadot JsonRPC interface", "main": "index.js", "keywords": [ @@ -30,8 +30,8 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-core#readme", "dependencies": { "@babel/runtime": "^7.1.2", - "@polkadot/jsonrpc": "^0.31.111", - "@polkadot/rpc-provider": "^0.31.111", + "@polkadot/jsonrpc": "^0.31.112", + "@polkadot/rpc-provider": "^0.31.112", "@polkadot/util": "^0.32.15" } } diff --git a/packages/rpc-provider/package.json b/packages/rpc-provider/package.json index 6aa01ae53c..2e976c5aa7 100644 --- a/packages/rpc-provider/package.json +++ b/packages/rpc-provider/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-provider", - "version": "0.31.111", + "version": "0.31.112", "description": "Transport providers for the API", "main": "index.js", "keywords": [ @@ -31,7 +31,7 @@ "dependencies": { "@babel/runtime": "^7.1.2", "@polkadot/keyring": "^0.32.15", - "@polkadot/storage": "^0.31.111", + "@polkadot/storage": "^0.31.112", "@polkadot/util": "^0.32.15", "@polkadot/util-crypto": "^0.32.15", "@types/nock": "^9.3.0", diff --git a/packages/rpc-rx/package.json b/packages/rpc-rx/package.json index a49b4fc2a7..aec1647823 100644 --- a/packages/rpc-rx/package.json +++ b/packages/rpc-rx/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-rx", - "version": "0.31.111", + "version": "0.31.112", "description": "An RxJs wrapper around the Polkadot JS API", "main": "index.js", "keywords": [ @@ -30,8 +30,8 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-rx#readme", "dependencies": { "@babel/runtime": "^7.1.2", - "@polkadot/rpc-core": "^0.31.111", - "@polkadot/rpc-provider": "^0.31.111", + "@polkadot/rpc-core": "^0.31.112", + "@polkadot/rpc-provider": "^0.31.112", "@types/rx": "^4.1.1", "rxjs": "^6.3.3" } diff --git a/packages/type-extrinsics/package.json b/packages/type-extrinsics/package.json index ac49a5d124..7f687ad451 100644 --- a/packages/type-extrinsics/package.json +++ b/packages/type-extrinsics/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/extrinsics", - "version": "0.31.111", + "version": "0.31.112", "main": "index.js", "repository": "https://github.com/polkadot-js/api.git", "author": "Jaco Greeff ", diff --git a/packages/type-jsonrpc/package.json b/packages/type-jsonrpc/package.json index dcf613566b..afb386fc48 100644 --- a/packages/type-jsonrpc/package.json +++ b/packages/type-jsonrpc/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/jsonrpc", - "version": "0.31.111", + "version": "0.31.112", "description": "Method definitions for the Polkadot RPC layer", "main": "index.js", "engines": { diff --git a/packages/type-storage/package.json b/packages/type-storage/package.json index 38f4c6bc46..0b7d77ad01 100644 --- a/packages/type-storage/package.json +++ b/packages/type-storage/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/storage", - "version": "0.31.111", + "version": "0.31.112", "description": "Generic wrapper wrapper around state storage", "main": "index.js", "engines": { @@ -31,7 +31,7 @@ "dependencies": { "@babel/runtime": "^7.1.2", "@polkadot/keyring": "^0.32.15", - "@polkadot/types": "^0.31.111", + "@polkadot/types": "^0.31.112", "@polkadot/util": "^0.32.15", "@polkadot/util-crypto": "^0.32.15" } diff --git a/packages/types/package.json b/packages/types/package.json index 3ec7cc60c4..c8ea1c177e 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/types", - "version": "0.31.111", + "version": "0.31.112", "description": "Implementation of the Parity codec", "main": "index.js", "keywords": [