Skip to content

Various formatting fixes #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
jsedn
=====

A javascript implementation of [edn](https://github.com/edn-format/edn). To see it in action checkout the [edn playground](https://shaunxcode.github.com/jsedn). If you open your browser console you will have access to a global jsedn object with which you can try things beside JSON encoding. I recommend `jsedn.unify("[?x was always better than ?y]", {x: "sonic", y: "mario"}).jsEncode()`.
A javascript implementation of [edn](https://github.com/edn-format/edn). To see it in action checkout the [edn playground](https://shaunxcode.github.com/jsedn). If you open your browser console you will have access to a global jsedn object with which you can try things beside JSON encoding. I recommend:
```js
jsedn.unify("[?x was always better than ?y]", {x: "sonic", y: "mario"}).jsEncode();
```

## Getting Started

Expand Down Expand Up @@ -186,21 +189,21 @@ outputs:

##Conversion Table

| element | edn | jsedn | js |
| --------------- | -------------------- | ------------------ | --- |
| nil | ```nil``` | ```null``` | ```null``` |
| boolean | ```true false``` | ```true false``` | ```true false``` |
| character | ```\c``` | ```"c"``` | ```"c"``` |
| string | ```"some string"``` | ```"some string"``` | ```"some string"``` |
| symbol | ```?sym~b~o!ol``` | ```edn.sym "?sym~b~o!ol"``` | ```"?sym~b~o!ol"``` |
| keywords | ```:keyword``` | ```edn.kw ":keyword"```| ```":keyword"``` |
| integer | ```666``` | ```666``` | ```666``` |
| floating point | ```-6.66``` | ```-6.66``` | ```-6.66``` |
| list | ```(a b (c d))``` | ```new edn.List([edn.sym("a"), edn.sym("b"), new edn.List([edn.sym("c"), edn.sym("d")])])``` | ```["a", "b", ["c", "d"]]``` |
| vector | ```[a b c]``` | ```new edn.Vector([edn.sym("a"), edn.sym("b"), edn.sym("c")])``` | ```["a", "b", "c"]``` |
| map | ```{:a 1 :b 2}``` | ```new edn.Map([edn.kw(":a"), 1, edn.kw(":b"), 2])``` | ```{a: 1, b: 2}``` |
| set | ```#{1 2 3}``` | ```new edn.Set([1, 2, 3])``` | ```[1 2 3]``` |
| tagged elements | ```#tagName [1 2]``` | ```new edn.Tagged(new edn.Tag("tagName"), new edn.Vector([1, 2]))``` | n/a |
| element | edn | jsedn | js |
| --------------- | ------------------ | ------------------ | --- |
| nil | `nil` | `null` | `null` |
| boolean | `true false` | `true false` | `true false` |
| character | `\c` | `"c"` | `"c"` |
| string | `"some string"` | `"some string"` | `"some string"` |
| symbol | `?sym~b~o!ol` | `edn.sym("?sym~b~o!ol")` | `"?sym~b~o!ol"` |
| keywords | `:keyword` | `edn.kw(":keyword")`| `":keyword"` |
| integer | `666` | `666` | `666` |
| floating point | `-6.66` | `-6.66` | `-6.66` |
| list | `(a b (c d))` | `new edn.List([edn.sym("a"), edn.sym("b"), new edn.List([edn.sym("c"), edn.sym("d")])])` | `["a", "b", ["c", "d"]]` |
| vector | `[a b c]` | `new edn.Vector([edn.sym("a"), edn.sym("b"), edn.sym("c")])` | `["a", "b", "c"]` |
| map | `{:a 1 :b 2}` | `new edn.Map([edn.kw(":a"), 1, edn.kw(":b"), 2])` | `{a: 1, b: 2}` |
| set | `#{1 2 3}` | `new edn.Set([1, 2, 3])` | `[1 2 3]` |
| tagged elements | `#tagName [1 2]` | `new edn.Tagged(new edn.Tag("tagName"), new edn.Vector([1, 2]))` | n/a |



Expand Down