interbtc-api

@interlay/interbtc-api / Exports / H256Le

Interface: H256Le

Name

H256Le

Hierarchy

Table of contents

Properties

Accessors

Methods

Properties

BYTES_PER_ELEMENT

• Readonly BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

Inherited from

H256.BYTES_PER_ELEMENT

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2161

[toStringTag]

• Readonly [toStringTag]: "Uint8Array"

Inherited from

H256.[toStringTag]

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:284

buffer

• Readonly buffer: ArrayBufferLike

The ArrayBuffer instance referenced by the array.

Inherited from

H256.buffer

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2166

byteLength

• Readonly byteLength: number

The length in bytes of the array.

Inherited from

H256.byteLength

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2171

byteOffset

• Readonly byteOffset: number

The offset in bytes of the array.

Inherited from

H256.byteOffset

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2176

createdAtHash

• Optional createdAtHash: IU8a

Inherited from

H256.createdAtHash

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:14

initialU8aLength

• Optional initialU8aLength: number

Inherited from

H256.initialU8aLength

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:15

isStorageFallback

• Optional isStorageFallback: boolean

Inherited from

H256.isStorageFallback

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:16

length

• Readonly length: number

The length of the array.

Inherited from

H256.length

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2275

registry

• Readonly registry: Registry

Inherited from

H256.registry

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:13

Accessors

encodedLength

• get encodedLength(): number

Returns

number

Description

The length of the value when encoded as a Uint8Array

Inherited from

H256.encodedLength

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:26

hash

• get hash(): IU8a

Returns

IU8a

Description

returns a hash of the contents

Inherited from

H256.hash

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:30

isAscii

• get isAscii(): boolean

Returns

boolean

Description

Returns true if the wrapped value contains only ASCII printable characters

Inherited from

H256.isAscii

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:34

isEmpty

• get isEmpty(): boolean

Returns

boolean

Description

Returns true if the type wraps an empty/default all-0 value

Inherited from

H256.isEmpty

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:38

isUtf8

• get isUtf8(): boolean

Returns

boolean

Description

Returns true if the wrapped value contains only utf8 characters

Inherited from

H256.isUtf8

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:42

Methods

[iterator]

▸ [iterator](): ArrayIterator<number>

Returns

ArrayIterator<number>

Inherited from

H256.[iterator]

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:302

at

▸ at(index): undefined | number

Takes an integer value and returns the item at that index, allowing for positive and negative integers. Negative integers count back from the last item in the array.

Parameters

Name Type
index number

Returns

undefined | number

Inherited from

H256.at

Defined in

node_modules/@types/node/globals.d.ts:297

bitLength

▸ bitLength(): number

Returns

number

Description

Returns the number of bits in the value

Inherited from

H256.bitLength

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:46

copyWithin

▸ copyWithin(target, start, end?): this

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

Name 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.
end? number If not specified, length of the this object is used as its default value.

Returns

this

Inherited from

H256.copyWithin

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2187

entries

▸ entries(): ArrayIterator<[number, number]>

Returns an array of key, value pairs for every entry in the array

Returns

ArrayIterator<[number, number]>

Inherited from

H256.entries

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:306

eq

▸ eq(other?): boolean

Parameters

Name Type
other? unknown

Returns

boolean

Description

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

Inherited from

H256.eq

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:50

every

▸ every(predicate, thisArg?): boolean

Determines whether all the members of an array satisfy the specified test.

Parameters

Name Type Description
predicate (value: number, index: number, array: Uint8Array) => unknown A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
thisArg? any An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

H256.every

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2197

fill

▸ fill(value, start?, end?): this

Changes all array elements from start to end index to a static value and returns the modified array

Parameters

Name Type Description
value number value to fill array section with
start? 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.
end? number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns

this

Inherited from

H256.fill

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2207

filter

▸ filter(predicate, thisArg?): Uint8Array

Returns the elements of an array that meet the condition specified in a callback function.

Parameters

Name Type Description
predicate (value: number, index: number, array: Uint8Array) => any A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
thisArg? any An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

Uint8Array

Inherited from

H256.filter

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2216

find

▸ find(predicate, thisArg?): undefined | number

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters

Name Type Description
predicate (value: number, index: number, obj: Uint8Array) => boolean 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.
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

undefined | number

Inherited from

H256.find

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2227

findIndex

▸ findIndex(predicate, thisArg?): number

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters

Name Type Description
predicate (value: number, index: number, obj: Uint8Array) => boolean 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.
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

Inherited from

H256.findIndex

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2238

forEach

▸ forEach(callbackfn, thisArg?): void

Performs the specified action for each element in an array.

Parameters

Name Type Description
callbackfn (value: number, index: number, array: Uint8Array) => void A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
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

Inherited from

H256.forEach

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2247

includes

▸ includes(searchElement, fromIndex?): boolean

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters

Name Type Description
searchElement number The element to search for.
fromIndex? number The position in this array at which to begin searching for searchElement.

Returns

boolean

Inherited from

H256.includes

Defined in

node_modules/typescript/lib/lib.es2016.array.include.d.ts:52

indexOf

▸ indexOf(searchElement, fromIndex?): number

Returns the index of the first occurrence of a value in an array.

Parameters

Name Type Description
searchElement number The value to locate in the array.
fromIndex? number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns

number

Inherited from

H256.indexOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2255

inspect

▸ inspect(): Inspect

Returns

Inspect

Description

Returns a breakdown of the hex encoding for this Codec

Inherited from

H256.inspect

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:54

join

▸ join(separator?): string

Adds all the elements of an array separated by the specified separator string.

Parameters

Name Type Description
separator? 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

Inherited from

H256.join

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2262

keys

▸ keys(): ArrayIterator<number>

Returns an list of keys in the array

Returns

ArrayIterator<number>

Inherited from

H256.keys

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:310

lastIndexOf

▸ lastIndexOf(searchElement, fromIndex?): number

Returns the index of the last occurrence of a value in an array.

Parameters

Name Type Description
searchElement number The value to locate in the array.
fromIndex? number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns

number

Inherited from

H256.lastIndexOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2270

map

▸ map(callbackfn, thisArg?): Uint8Array

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters

Name Type Description
callbackfn (value: number, index: number, array: Uint8Array) => number A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
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

Inherited from

H256.map

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2285

reduce

▸ reduce(callbackfn): number

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

Name Type Description
callbackfn (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number 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

H256.reduce

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2297

▸ reduce(callbackfn, initialValue): number

Parameters

Name Type
callbackfn (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number
initialValue number

Returns

number

Inherited from

H256.reduce

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2298

▸ reduce<U>(callbackfn, initialValue): U

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

Name
U

Parameters

Name Type Description
callbackfn (previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U 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

Inherited from

H256.reduce

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2310

reduceRight

▸ reduceRight(callbackfn): number

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

Name Type Description
callbackfn (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number 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

H256.reduceRight

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2322

▸ reduceRight(callbackfn, initialValue): number

Parameters

Name Type
callbackfn (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number
initialValue number

Returns

number

Inherited from

H256.reduceRight

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2323

▸ reduceRight<U>(callbackfn, initialValue): U

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

Name
U

Parameters

Name Type Description
callbackfn (previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U 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

Inherited from

H256.reduceRight

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2335

reverse

▸ reverse(): Uint8Array

Reverses the elements in an Array.

Returns

Uint8Array

Inherited from

H256.reverse

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2340

set

▸ set(array, offset?): void

Sets a value or an array of values.

Parameters

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
offset? number The index in the current array at which the values are to be written.

Returns

void

Inherited from

H256.set

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2347

slice

▸ slice(start?, end?): Uint8Array

Returns a section of an array.

Parameters

Name Type Description
start? number The beginning of the specified portion of the array.
end? number The end of the specified portion of the array. This is exclusive of the element at the index ‘end’.

Returns

Uint8Array

Inherited from

H256.slice

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2354

some

▸ some(predicate, thisArg?): boolean

Determines whether the specified callback function returns true for any element of an array.

Parameters

Name Type Description
predicate (value: number, index: number, array: Uint8Array) => unknown A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.
thisArg? any An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

H256.some

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2364

sort

▸ sort(compareFn?): this

Sorts an array.

Parameters

Name Type Description
compareFn? (a: number, b: number) => number Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they’re equal and a positive value otherwise. If omitted, the elements are sorted in ascending order. ts [11,2,22,1].sort((a, b) => a - b)

Returns

this

Inherited from

H256.sort

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2375

subarray

▸ subarray(begin?, end?): Uint8Array

Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

Parameters

Name Type Description
begin? number The index of the beginning of the array.
end? number The index of the end of the array.

Returns

Uint8Array

Inherited from

H256.subarray

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2383

toHex

▸ toHex(): `0x${string}`

Returns

`0x${string}`

Description

Returns a hex string representation of the value

Inherited from

H256.toHex

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:58

toHuman

▸ toHuman(): AnyJson

Returns

AnyJson

Description

Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information

Inherited from

H256.toHuman

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:62

toJSON

▸ toJSON(): string

Returns

string

Description

Converts the Object to JSON, typically used for RPC transfers

Inherited from

H256.toJSON

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:66

toLocaleString

▸ toLocaleString(): string

Converts a number to a string by using the current locale.

Returns

string

Inherited from

H256.toLocaleString

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2388

▸ toLocaleString(locales, options?): string

Parameters

Name Type
locales string | string[]
options? NumberFormatOptions

Returns

string

Inherited from

H256.toLocaleString

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:568

toPrimitive

▸ toPrimitive(): AnyJson

Returns

AnyJson

Description

Converts the value in a best-fit primitive form

Inherited from

H256.toPrimitive

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:70

toRawType

▸ toRawType(): string

Returns

string

Description

Returns the base runtime type name for this instance

Inherited from

H256.toRawType

Defined in

node_modules/@polkadot/types-codec/extended/U8aFixed.d.ts:15

toString

▸ toString(): string

Returns

string

Description

Returns the string representation of the value

Inherited from

H256.toString

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:78

toU8a

▸ toU8a(_isBare?): Uint8Array

Parameters

Name Type
_isBare? boolean

Returns

Uint8Array

Description

Encodes the value as a Uint8Array as per the SCALE specifications

Inherited from

H256.toU8a

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:82

toUtf8

▸ toUtf8(): string

Returns

string

Description

Returns the wrapped data as a UTF-8 string

Inherited from

H256.toUtf8

Defined in

node_modules/@polkadot/types-codec/native/Raw.d.ts:86

valueOf

▸ valueOf(): Uint8Array

Returns the primitive value of the specified object.

Returns

Uint8Array

Inherited from

H256.valueOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:2396

values

▸ values(): ArrayIterator<number>

Returns an list of values in the array

Returns

ArrayIterator<number>

Inherited from

H256.values

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:314

This site is open source. Improve this page.