Files

T

Jaco Greeff 5d0a7231dc Fix alias links (#34 )

* Fix alias links

* Update alias links

* Update generated docs

2017-12-01 20:34:51 +01:00

2.1 KiB

Raw Blame History

buffer

Utility methods to convert to and from Buffer objects

bufferFromHex Creates a Buffer object from a hex string.
bufferFromNumber Creates a Buffer object from a number.
bufferFromU8a Creates a Buffer object from a Uint8Array.
bufferToHex Creates a hex value from a Buffer object.
bufferToNumber Creates a Number value from a Buffer object.
bufferToU8a Creates a Uint8Array value from a Buffer object.

bufferFromHex

Creates a Buffer object from a hex string. (alias of hexToBuffer)

bufferFromHex (value?: string): Buffer

bufferFromNumber

Creates a Buffer object from a number. (alias of numberToBuffer)

bufferFromNumber (value?: number): Buffer

bufferFromU8a

Creates a Buffer object from a Uint8Array. (alias of u8aToBuffer)

bufferFromU8a (value?: string): Buffer

bufferToHex

Creates a hex value from a Buffer object.

bufferToHex (value?: Buffer): string

null inputs returns a 0x result, Buffer values return the actual value as a 0x prefixed hex value. Anything that is not a Buffer object throws an error.

import { bufferToHex } from '@polkadot/util';

console.log('Hex value', bufferToHex(Buffer.from([1, 2, 3]));

bufferToNumber

Creates a Number value from a Buffer object.

bufferToNumber (value?: Buffer): number

null inputs returns an NaN result, Buffer values return the actual value as a Number.

import { bufferToNumber } from '@polkadot/util';

bufferToNumber(Buffer.from([12, 34, 56])); // => 0x123456

bufferToU8a

Creates a Uint8Array value from a Buffer object.

bufferToU8a (value?: Buffer): string

null inputs returns an empty result, Buffer values return the actual value as a Uint8Array. Anything that is not a Buffer object throws an error.

import { bufferToU8a } from '@polkadot/util';

bufferToU8a(Buffer.from([1, 2, 3]));

2.1 KiB Raw Blame History