@xylabs/decimal-precision 4.13.20 → 4.13.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +85 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,13 +12,95 @@
|
|
|
12
12
|
[![snyk-badge][]][snyk-link]
|
|
13
13
|
[![socket-badge][]][socket-link]
|
|
14
14
|
|
|
15
|
-
Version: 4.13.19
|
|
16
15
|
|
|
17
16
|
Base functionality used throughout XY Labs TypeScript/JavaScript libraries
|
|
18
17
|
|
|
19
|
-
## Documentation
|
|
18
|
+
## API Documentation
|
|
19
|
+
|
|
20
|
+
**@xylabs/decimal-precision**
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
## Functions
|
|
25
|
+
|
|
26
|
+
- [fromFixedPoint](#functions/fromFixedPoint)
|
|
27
|
+
- [toDecimalPrecision](#functions/toDecimalPrecision)
|
|
28
|
+
- [toFixedPoint](#functions/toFixedPoint)
|
|
29
|
+
|
|
30
|
+
### functions
|
|
31
|
+
|
|
32
|
+
### <a id="fromFixedPoint"></a>fromFixedPoint
|
|
33
|
+
|
|
34
|
+
[**@xylabs/decimal-precision**](#../README)
|
|
35
|
+
|
|
36
|
+
***
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
function fromFixedPoint(value, places): bigint;
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Parameters
|
|
43
|
+
|
|
44
|
+
### value
|
|
45
|
+
|
|
46
|
+
`bigint`
|
|
47
|
+
|
|
48
|
+
### places
|
|
49
|
+
|
|
50
|
+
`number` = `18`
|
|
51
|
+
|
|
52
|
+
## Returns
|
|
53
|
+
|
|
54
|
+
`bigint`
|
|
55
|
+
|
|
56
|
+
### <a id="toDecimalPrecision"></a>toDecimalPrecision
|
|
57
|
+
|
|
58
|
+
[**@xylabs/decimal-precision**](#../README)
|
|
59
|
+
|
|
60
|
+
***
|
|
61
|
+
|
|
62
|
+
```ts
|
|
63
|
+
function toDecimalPrecision(value, digits): string;
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## Parameters
|
|
67
|
+
|
|
68
|
+
### value
|
|
69
|
+
|
|
70
|
+
`number`
|
|
71
|
+
|
|
72
|
+
### digits
|
|
73
|
+
|
|
74
|
+
`number`
|
|
75
|
+
|
|
76
|
+
## Returns
|
|
77
|
+
|
|
78
|
+
`string`
|
|
79
|
+
|
|
80
|
+
### <a id="toFixedPoint"></a>toFixedPoint
|
|
81
|
+
|
|
82
|
+
[**@xylabs/decimal-precision**](#../README)
|
|
83
|
+
|
|
84
|
+
***
|
|
85
|
+
|
|
86
|
+
```ts
|
|
87
|
+
function toFixedPoint(value, places): bigint;
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## Parameters
|
|
91
|
+
|
|
92
|
+
### value
|
|
93
|
+
|
|
94
|
+
`string` | `bigint`
|
|
95
|
+
|
|
96
|
+
### places
|
|
97
|
+
|
|
98
|
+
`number` = `18`
|
|
99
|
+
|
|
100
|
+
## Returns
|
|
101
|
+
|
|
102
|
+
`bigint`
|
|
20
103
|
|
|
21
|
-
Coming Soon!
|
|
22
104
|
|
|
23
105
|
Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
|
|
24
106
|
|