@molecule/api-fx-rates 1.0.3 → 1.0.4
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 +5 -5
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@ AUTO-GENERATED — DO NOT EDIT THIS FILE.
|
|
|
3
3
|
Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
|
|
4
4
|
Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
|
|
5
5
|
To change this document, edit the module-level JSDoc in src/index.ts.
|
|
6
|
-
Generated: 2026-10-
|
|
6
|
+
Generated: 2026-10-26T04:22:47.959Z
|
|
7
7
|
-->
|
|
8
8
|
|
|
9
9
|
# @molecule/api-fx-rates
|
|
@@ -232,7 +232,7 @@ function hasProvider(): boolean
|
|
|
232
232
|
Looks up the conversion rate `1 unit of from = rate units of to`.
|
|
233
233
|
|
|
234
234
|
```typescript
|
|
235
|
-
function getRate(from:
|
|
235
|
+
function getRate(from: CurrencyCode, to: CurrencyCode, options?: FxRatesOptions): Promise<number>
|
|
236
236
|
```
|
|
237
237
|
|
|
238
238
|
- `from` — Source currency (ISO 4217).
|
|
@@ -262,8 +262,8 @@ another using the bonded provider.
|
|
|
262
262
|
```typescript
|
|
263
263
|
function convert(
|
|
264
264
|
amountMinor: number,
|
|
265
|
-
from:
|
|
266
|
-
to:
|
|
265
|
+
from: CurrencyCode,
|
|
266
|
+
to: CurrencyCode,
|
|
267
267
|
options?: FxRatesOptions,
|
|
268
268
|
): Promise<number>
|
|
269
269
|
```
|
|
@@ -280,7 +280,7 @@ function convert(
|
|
|
280
280
|
Lists every currency the bonded provider currently supports.
|
|
281
281
|
|
|
282
282
|
```typescript
|
|
283
|
-
function listSupportedCurrencies(): Promise<
|
|
283
|
+
function listSupportedCurrencies(): Promise<CurrencyCode[]>
|
|
284
284
|
```
|
|
285
285
|
|
|
286
286
|
**Returns:** Array of ISO 4217 currency codes.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@molecule/api-fx-rates",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.4",
|
|
4
4
|
"description": "Foreign exchange rates core interface for molecule.dev",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -34,8 +34,8 @@
|
|
|
34
34
|
"@molecule/api-i18n": "^1.0.1"
|
|
35
35
|
},
|
|
36
36
|
"devDependencies": {
|
|
37
|
-
"@molecule/api-bond": "1.0.
|
|
38
|
-
"@molecule/api-i18n": "1.0.
|
|
37
|
+
"@molecule/api-bond": "1.0.4",
|
|
38
|
+
"@molecule/api-i18n": "1.0.5",
|
|
39
39
|
"@types/node": "26.6.5",
|
|
40
40
|
"typescript": "6.0.3",
|
|
41
41
|
"vitest": "4.1.12"
|