Files
common/docs/buffer.md
T
Jaco Greeff d02c05ba49 Alias to <-> from (#31)
* bn <-> hex aliasses

* Bump minor

* Split tests into singular files

* to <-> from alias

* Add Codeclimate badge
2017-11-30 20:16:17 +01:00

2.2 KiB

buffer

Utility methods to convert to and from Buffer objects

  • bufferFromHex Creates a Buffer object from a hex string. [hex.md#hextobuffer](alias hexToBuffer)
  • bufferFromNumber Creates a Buffer object from a number. [number.md#numbertobuffer](alias numberToBuffer)
  • bufferFromU8a Creates a Buffer object from a Uint8Array. [u8a.md#u8atobuffer](alias u8aToBuffer)
  • 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. [hex.md#hextobuffer](alias hexToBuffer)

bufferFromHex (value?: string): Buffer

bufferFromNumber

Creates a Buffer object from a number. [number.md#numbertobuffer](alias numberToBuffer)

bufferFromNumber (value?: number): Buffer

bufferFromU8a

Creates a Buffer object from a Uint8Array. [u8a.md#u8atobuffer](alias 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]));