Skip to content

formatting fixes in README #52

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.

Sign up for GitHub

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

formatting fixes in README #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ edn.parse(edn.encode({
```
Will output `"electric"`. Definitely working in both directions.

###Command Line
### Command Line
If you have installed via `npm` you will have a jsedn script that accepts input via pipe/stdin. Currently takes:

* `-s` flag for "select" which you pass a path separated by space
Expand All @@ -75,21 +75,21 @@ npm test
```

## API
#####parse (ednString)
##### parse (ednString)
Will turn a valid edn string into a js object structure based upon the classes details below.

```js
edn.parse("{:a-keyword! [1 2 -3.4]}");
```

#####encode (jsObj)
##### encode (jsObj)
Will encode both native JS and any object providing a ednEncode method.

```js
edn.encode({"a-keyword!": [1,2,-3.4]});
```

#####setTagAction (tag, action)
##### setTagAction (tag, action)
Will add the tag action to be performed on any data prepended by said tag.

```js
Expand All @@ -100,21 +100,21 @@ edn.setTagAction(new edn.Tag('myApp', 'tagName'), function(obj) {
});
```

#####setTokenPattern (tokenName, pattern)
##### setTokenPattern (tokenName, pattern)
If for some reason you would like to over-ride or add a new token pattern.

```js
edn.setTokenPattern()))
```

#####setTokenAction (tokenName, actionCallback)
##### setTokenAction (tokenName, actionCallback)
Allows for customization of token handling upon match. For instance if you decided you would prefer nil to be represented by undefined instead of null (default).

```js
edn.setTokenAction('nil', function(token) { return undefined;});
```

#####setTypeClass (type, class)
##### setTypeClass (type, class)
This is useful if you want to over-ride the naive implementations of Map etc.

```js
Expand Down