Remove {from,to}Buffer methods (#89)

* Remove all {from,to}Buffer utility methods

* Fix check & test

* Updsate docs

* Bump minor
This commit is contained in:
Jaco Greeff
2018-02-15 10:32:05 +01:00
committed by GitHub
parent 06eb66f84e
commit 6f8c54337b
36 changed files with 34 additions and 512 deletions
-31
View File
@@ -5,12 +5,10 @@ Internal utilities to create and test for hex values
- [hexAddPrefix](#hexaddprefix) Adds the `0x` prefix to string values.
- [hexFixLength](#hexfixlength) Shifts a hex string to a specific bitLength
- [hexFromBn](#hexfrombn) Creates a hex value from a BN.js bignumber object.
- [hexFromBuffer](#hexfrombuffer) Creates a hex value from a Buffer object.
- [hexFromNumber](#hexfromnumber) Creates a hex value from a number.
- [hexHasPrefix](#hexhasprefix) Tests for the existence of a `0x` prefix.
- [hexStripPrefix](#hexstripprefix) Strips any leading `0x` prefix.
- [hexToBn](#hextobn) Creates a BN.js bignumber object from a hex string.
- [hexToBuffer](#hextobuffer) Creates a Buffer object from a hex string.
- [hexToNumber](#hextonumber) Creates a Number value from a Buffer object.
- [hexToU8a](#hextou8a) Creates a Buffer object from a hex string.
@@ -62,18 +60,6 @@ hexFromBn (value?: BN): string
## hexFromBuffer
Creates a hex value from a Buffer object. [(alias of bufferToHex)](buffer.md#buffertohex)
```js
hexFromBuffer (value?: Buffer): string
```
## hexFromNumber
Creates a hex value from a number. [(alias of numberToHex)](number.md#numbertohex)
@@ -137,23 +123,6 @@ import { hexToBn } from '@polkadot/util';
hexToBn('0x123480001f'); // => BN(0x123480001f)
```
## hexToBuffer
Creates a Buffer object from a hex string.
```js
hexToBuffer (value?: string): Buffer
```
`null` inputs returns an empty `Buffer` result. Hex input values return the actual bytes value converted to a Buffer. Anything that is not a hex string (including the `0x` prefix) throws an error.
```js
import { hexToBuffer } from '@polkadot/util';
hexToBuffer('0x123480001f'); // Buffer([0x12, 0x34, 0x80, 0x00, 0x1f])
```
## hexToNumber
Creates a Number value from a Buffer object.