utils for CENNZnet api
npm install @cennznet/utilUtils for CENNZNet
* formatUnits
* isSafeInteger
* parseUnits
* stripEndZero
* toFixed
---
● INTEGER: RegExp = /^\d+$/
Defined in packages/util/src/is/integer.ts:15
● STRIP_ZERO: RegExp = /^(.?)(0)$/
Defined in packages/util/src/format/stripEndZero.ts:17
___
▸ formatUnits(unValue: BN \| number \| string, decimals: number): string
Defined in packages/util/src/unit/formatUnits.ts:25
format a amount from unit un to decimals passed in.
Parameters:
| Name | Type | Description |
| ------ | ------ | ------ |
| unValue | BN \| number \| string | \- |
| decimals | number | |
Returns: string
▸ isSafeInteger(value: any): boolean
Defined in packages/util/src/is/integer.ts:30
Check if the input is a integer
__example__:
``javascript
import { isInteger } from '@cennznet/util';
console.log('isInteger', isInteger(123)); // => true
console.log('isInteger', isInteger(123456789012345678)); // => false
console.log('isInteger', isInteger('123')); // => true
console.log('isInteger', isInteger('12.3')); // => false
`
Parameters:
| Name | Type |
| ------ | ------ |
| value | any |
Returns: boolean
▸ parseUnits(value: string \| number, decimals: number): BN
Defined in packages/util/src/unit/parseUnits.ts:27
format a amount from unit un to decimals passed in.
Parameters:
| Name | Type | Description |
| ------ | ------ | ------ |
| value | string \| number |number
| decimals | | |
Returns: BN
▸ stripEndZero(value: string): string
Defined in packages/util/src/format/stripEndZero.ts:23
trim all trailing zeros. return '' if only zero is passed in.
Parameters:
| Name | Type | Description |
| ------ | ------ | ------ |
| value | string | |
Returns: string
▸ toFixed(x: number): string
Defined in packages/util/src/number/toFixed.ts:19
convert number to string, without science notion
Parameters:
| Name | Type | Description |
| ------ | ------ | ------ |
| x | number | |
Returns: string`
___