Files
common/packages/util/docs/number.md
T
Jaco Greeff b5c5734c7c Add Blake2s & XXHash utility functions (#66)
* Initial split of util & util-crypto

* Add initial XXHash version

* Blake2s wit tests & documentation

* Add sha512 (from NaCl)

* Add randomBytes (from NaCl)

* Flow fixes

* Update documentation

* Update latest @polkadot/dev
2018-01-25 14:13:43 +01:00

66 lines
1.4 KiB
Markdown

# number
Utility methods to convert to and from `number` values
- [numberFromBuffer](#numberfrombuffer) Creates a Number value from a Buffer object.
- [numberFromHex](#numberfromhex) Creates a Number value from a Buffer object.
- [numberToBuffer](#numbertobuffer) Creates a Buffer object from a number.
- [numberToHex](#numbertohex) Creates a hex value from a number.
## numberFromBuffer
Creates a Number value from a Buffer object. [(alias of bufferToNumber)](buffer.md#buffertonumber)
```js
numberFromBuffer (value?: Buffer): number
```
## numberFromHex
Creates a Number value from a Buffer object. [(alias of hexToNumber)](hex.md#hextonumber)
```js
numberFromHex (value?: Hex): number
```
## numberToBuffer
Creates a Buffer object from a number.
```js
numberToBuffer (value?: number): Buffer
```
`null`/`undefined`/`NaN` inputs returns an empty `Buffer` result. `number` input values return the actual bytes value converted to a `Buffer`.
```js
import { numberToBuffer } from '@polkadot/util';
const buffer = numberToBuffer(0x1234); // => Buffer.from([0x12, 0x34])
```
## numberToHex
Creates a hex value from a number.
```js
numberToHex (value?: number): string
```
`null`/`undefined`/`NaN` inputs returns an empty `0x` result. `number` input values return the actual bytes value converted to a `hex`.
```js
import { numberToHex } from '@polkadot/util';
const hex = numberToHex(0x1234); // => '0x1234'
```