# edn-js

> A reader/writer for EDN in JS

Latest version **0.0.4** (published 2016-05-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install edn-js
pnpm add edn-js
yarn add edn-js
bun add edn-js
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2016-05-22 |
| First published | 2015-10-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Jake Rosoman |
| Maintainers | jkroso |
| Keywords | edn |

## Links

- npm: https://www.npmjs.com/package/edn-js
- Repository: https://github.com/jkroso/edn.js
- Homepage: https://github.com/jkroso/edn.js#readme
- Issues: https://github.com/jkroso/edn.js/issues
- npm.io page: https://npm.io/package/edn-js

## Dependencies (2)

- [parse-mime](https://npm.io/package/parse-mime.md) *
- [@jkroso/type](https://npm.io/package/@jkroso/type.md) 2

## Recent versions

- 0.0.4 (latest) — 2016-05-22
- 0.0.3 — 2016-01-16
- 0.0.2 — 2016-01-02
- 0.0.1 — 2016-01-02
- 0.0.0 — 2015-10-21

## README

# edn-js

An EDN reader and an EDN writer for JS. It tries to use native JS types when possible but currently JS has no equivalent of EDN's List or UUID; so edn-js provides them.

In addition to standard EDN this implementation also supports cyclic data.

## Installation

`npm install edn-js`

then in your app:

```js
const {read,write,edn,List,UUID} = require('edn-js')
```

## API

### `read(str)`

Just takes a string of EDN data and returns the best approximation of it in native JS data

```js
read('[1 2]') // => [1, 2]
read('#{1 2}') // => new Set([1, 2])
read('{1 2}') // => new Map([[1, 2]])
```

### `write(value)`

Converts any value to its EDN representation. If its not a builtin type then it should implement either `toEDN()` returning a string or `toJSON()` returning a plain `Object`.

```js
write(new Date(0)) // => '#inst "1970-01-01T00:00:00.000Z"'
write(new Set([1,2,3])) // => '#{1 2 3}'
write(new Map([[Symbol('a'), 1]])) // => '{a 1}'
write({a: 1, b: 2}) // => '#js/Object {"a" 1 "b" 2}'
write([1,2]) // => '#js/Array [1 2]'
```

### ``edn`str` ``

This function is designed to be used with ES6's tagged template strings

```js
edn`(1 2)` // => List.from([1,2])
```

And if you want to interpolate values it does it without serializing them so identity is preserved

```js
const object = {}
edn`(${object})` // => List.from([object])
```

### Support for cyclic data

```js
const m = new Map
m.set('self', m)
write(m) // => '{"self" # 1}'
const copy = read('{"self" # 1}')
copy.get('self') == copy // => true
```

---
_Source: https://npm.io/package/edn-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._