@burstjs/util NPM

@burstjs/util

Useful utilities and tools for building Burstcoin applications

Installation

@burstjs/http can be used with NodeJS or Web. Two formats are available

Using with NodeJS and/or modern web frameworks

Install using npm:

npm install @burstjs/util

or using yarn:

yarn add @burstjs/util

Example

import {convertNumberToNQTString} from '@burstjs/util'

const value = convertNumberToNQTString(1000)
console.log(value)

Using in classic `<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>

Example

const value = b$util.convertNumberToNQTString(1000)
console.log(value)

See more here:

@burstjs/util Online Documentation

API Reference

Modules

Constants

Functions

util

util ⇒

Returns: The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util ⇒ string

Returns: string - The orginal string

Param	Description
b64	The string to be decoded (either URI encoded or not)

util ⇒

Deprecated

Returns: Date

Param	Description
burstTimestamp	The numeric Id

util ⇒

Deprecated

Returns: Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util ⇒ string

Returns: string - A hex string representing the byte array input

Param	Description
bytes	The (unsigned) byte array to be converted
uppercase	If true, converts hex string with uppercase characters (Default: false)

util ⇒ string

Returns: string - The converted string

Param	Description
byteArray	The byte array to be converted
startIndex	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

util ⇒

Deprecated

Returns: The Burst Timestamp

Param	Description
date	The date to be converted

util ⇒

Returns: A hexadecimal string
Note:: Negative numbers are expressed as Two's Complement (https://en.wikipedia.org/wiki/Two%27s_complement) Credits to AJ ONeal for the two's complements stuff https://coolaj86.com/articles/convert-decimal-to-hex-with-js-bigints/

Param	Description
decimal	A decimal string or BigNumber representation
padding	If set the hex string will be padded to given number, 8 or 16 or more

util ⇒

Returns: The converted string as hex string

Param	Description
hexString	The hex string to be converted

util ⇒ Array.<number>

Returns: Array.<number> - An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util ⇒

Returns: A decimal string

Param	Description
hexStr	A hexadecimal string

util ⇒ string

Returns: string - The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util ⇒

Deprecated

Returns: A number expressed in Burst (not NQT)
Throws:

Param	Description
amount	The amount in Planck (aka NQT)

util ⇒

Deprecated

Returns: a NQT number string

Param	Description
n	the number

util ⇒

Returns: the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util ⇒ string

Returns: string - The Base64 String representing the input string. The string is already URI encoded, i.e. can be used directly in browsers

Param	Description
str	The string to be converted
isURICompatible	Determine whether the resulting string shall be URI compatible, or not. Default is true

util ⇒ Array.<number>

Returns: Array.<number> - A byte array representing the string input

Param	Description
str	The string to be converted

util ⇒ string

Returns: string - The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util ⇒

Returns: The Deeplink
See: [parseDeeplink] as inverse function

Param	Type	Description
args	CreateDeeplinkArgs	The arguments for the deeplink

util

util ⇒ boolean

Returns: boolean - true, if is a valid address, else false
Internal: Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)