Skip to content

Commit 9e83a9c

Browse files
committed
Docs: Drop nodejs requirement; browser is supported
1 parent 6bd6c25 commit 9e83a9c

2 files changed

Lines changed: 11 additions & 6 deletions

File tree

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
1-
Declarative Mapper for Node.js
2-
=============================
1+
Declarative Mapper
2+
==================
33

44
[![Version](https://img.shields.io/npm/v/declarative-mapper.svg)](https://www.npmjs.com/package/declarative-mapper)
55
[![Coverage](https://coveralls.io/repos/github/snatalenko/declarative-mapper/badge.svg?branch=master&v=1.7.1)](https://coveralls.io/github/snatalenko/declarative-mapper?branch=master)
66
[![Downloads](https://img.shields.io/npm/dm/declarative-mapper.svg)](https://www.npmjs.com/package/declarative-mapper)
77
[![License](https://img.shields.io/github/license/snatalenko/declarative-mapper.svg?v=1.7.1)](https://github.com/snatalenko/declarative-mapper)
88
[![Tests/Audit](https://github.com/snatalenko/declarative-mapper/actions/workflows/ci.yml/badge.svg)](https://github.com/snatalenko/declarative-mapper/actions)
99

10-
## Table of Contents
10+
## Overview
11+
12+
Declarative Mapper is a JSON data transformation and object mapping library for JavaScript/TypeScript. Define declarative mapping templates to convert documents quickly, with schema helpers and safe VM-based execution.
13+
14+
### Table of Contents
1115

1216
- [Overview](#overview)
17+
- [Reasoning](#reasoning)
1318
- [Quick Start Example](#quick-start-example)
1419
- [Compatibility](#compatibility)
1520
- [Mapping Instructions](#mapping-instructions)
@@ -23,7 +28,7 @@ Declarative Mapper for Node.js
2328
- [Dynamic Output Keys](#dynamic-output-keys)
2429
- [Complex Mapping Example](#complex-mapping-example)
2530

26-
## Overview
31+
### Reasoning
2732

2833
On several projects, I needed a library that could convert one JSON format to another (for example, an invoice from one system into another). It had to support **declarative mapping** instructions so users could configure mappings from a UI. It also had to be **flexible** enough for complex requirements, **secure** against JS injection, and **fast** enough to process streams with millions of records.
2934

@@ -75,7 +80,7 @@ const mapper = createMapper({
7580
const results = sourceOrders.map(mapper);
7681
```
7782

78-
## Compatibility
83+
### Compatibility
7984

8085
- **Node.js:** 16+
8186
- **Browser:** best effort support; requires a `vm` polyfill

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "declarative-mapper",
33
"version": "1.7.1",
4-
"description": "Declarative JSON and object mapper for Node.js/TypeScript: transform data with mapping templates, schema-based helpers, and safe VM execution.",
4+
"description": "Declarative JSON data transformation and object mapping library for JavaScript/TypeScript with mapping templates, schema-based helpers, and safe VM execution.",
55
"keywords": [
66
"config-driven",
77
"data-mapper",

0 commit comments

Comments
 (0)