Skip to content

Commit 6bd6c25

Browse files
committed
Docs: Add compatibility and engine requirements
1 parent 6ac50d8 commit 6bd6c25

2 files changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Declarative Mapper for Node.js
1111

1212
- [Overview](#overview)
1313
- [Quick Start Example](#quick-start-example)
14+
- [Compatibility](#compatibility)
1415
- [Mapping Instructions](#mapping-instructions)
1516
- [Runtime Variables Quick Reference](#runtime-variables-quick-reference)
1617
- [Objects](#objects)
@@ -74,6 +75,11 @@ const mapper = createMapper({
7475
const results = sourceOrders.map(mapper);
7576
```
7677

78+
## Compatibility
79+
80+
- **Node.js:** 16+
81+
- **Browser:** best effort support; requires a `vm` polyfill
82+
7783
## Mapping Instructions
7884

7985
In mapping JSON, the left side is a key in the resulting object.

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020
"typescript"
2121
],
2222
"type": "module",
23+
"engines": {
24+
"node": ">=16"
25+
},
2326
"main": "dist/cjs/index.js",
2427
"types": "types/index.d.ts",
2528
"exports": {

0 commit comments

Comments
 (0)