@burstjs/util
Advanced tools
Useful utilities and tools for building Burstcoin applications
@burstjs/http can be used with NodeJS or Web. Two formats are available
Install using npm:
npm install @burstjs/util
or using yarn:
yarn add @burstjs/util
import {convertNumberToNQTString} from '@burstjs/util'
const value = convertNumberToNQTString(1000)
console.log(value)
<script>Each package is available as bundled standalone library using IIFE.
This way burstJS can be used also within <script>-Tags.
This might be useful for Wordpress and/or other PHP applications.
Just import the package using the HTML <script> tag.
<script src='https://cdn.jsdelivr.net/npm/@burstjs/util/dist/util.crypto.min.js'></script>
const value = b$util.convertNumberToNQTString(1000)
console.log(value)
See more here:
@burstjs/util Online Documentation
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
booleanstringstringArray.<number>stringArray.<number>stringbooleanbooleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: static property of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id
Kind: inner method of util
Returns:
The numeric id, or undefined if address is invalid
| Param | Description |
|---|---|
| address | The BURST address |
Converts a Burst/Block Time (seconds since genesis block) into Date
Kind: inner method of util
Returns:
Date
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)
Kind: inner method of util
Returns:
Unix Epoch Time (milliseconds since 01.01.1970)
| Param | Description |
|---|---|
| burstTimestamp | The numeric Id |
stringConverts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]
Kind: inner method of util
Returns: string -
A hex string representing the byte array input
| Param | Default | Description |
|---|---|---|
| bytes | The byte array to be converted | |
| uppercase | false | If true, converts hex string with uppercase characters (Default: false) |
stringConverts a byte array into string Inverse function [[convertStringToByteArray]]
Kind: inner method of util
Returns: string -
The converted string
| Param | Default | Description |
|---|---|---|
| byteArray | The byte array to be converted | |
| startIndex | 0 | The starting index of array to be converted (Default: 0) |
| length | | The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered |
Converts a Date into Burst/Block Time (seconds since genesis block)
Kind: inner method of util
Returns:
The Burst Timestamp
| Param | Description |
|---|---|
| date | The date to be converted |
Array.<number>Converts an hexadecimal string to byte array
Kind: inner method of util
Returns: Array.<number> -
An byte array representing the hexadecimal input
| Param | Description |
|---|---|
| hex | The hexadecimal string to be converted |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: inner method of util
Returns:
A decimal string
| Param | Description |
|---|---|
| hexStr | A hexadecimal string |
stringConverts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]
Kind: inner method of util
Returns: string -
The string represented by the Hex String
| Param | Description |
|---|---|
| hex | The Hex string to be converted |
Helper method to convert a String to number
Kind: inner method of util
Returns:
A number expressed in Burst (not NQT)
exception if argument is invalid
| Param | Description |
|---|---|
| amount | The amount in NQT |
Helper method to Number to String(8 decimals) representation
Kind: inner method of util
Returns:
a NQT number string
| Param | Description |
|---|---|
| n | the number |
Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX
Kind: inner method of util
Returns:
the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined
| Param | Description |
|---|---|
| numericId | The numeric Id |
Array.<number>Converts a string into byte array Inverse function [[convertByteArrayToString]]
Kind: inner method of util
Returns: Array.<number> -
A byte array representing the string input
| Param | Description |
|---|---|
| str | The string to be converted |
stringConverts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]
Kind: inner method of util
Returns: string -
The Hex String representing the input string
| Param | Description |
|---|---|
| str | The Hex string to be converted |
booleanCheck for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)
Kind: inner method of util
Returns: boolean -
true, if is a valid address, else false
| Param | Type | Description |
|---|---|---|
| address | string | The address |
Sums various NQT values and returns in Burst
Kind: inner method of util
Returns:
The sum of all amounts in BURST
| Param | Description |
|---|---|
| ...nqts | Variable amount list with NQT string |
FAQs
Useful utilities and tools for building Burstcoin applications
We found that @burstjs/util demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."