Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pvorb/jsml
Appendable sequences of JSON documents
https://github.com/pvorb/jsml
Last synced: about 1 month ago
JSON representation
Appendable sequences of JSON documents
- Host: GitHub
- URL: https://github.com/pvorb/jsml
- Owner: pvorb
- License: mit
- Created: 2012-08-09T21:29:26.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2013-04-16T14:43:19.000Z (over 11 years ago)
- Last Synced: 2024-09-18T12:22:32.121Z (2 months ago)
- Language: JavaScript
- Homepage: https://npmjs.org/package/jsml
- Size: 117 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
JSML
====
Appendable sequences of JSON documents
There’s an issue with JSON that I can’t tolerate: If you want to add a new
object to a JSON document, you have to rewrite the whole document. That makes it
inappropriate for logging an similar tasks. This is where JSML pitches in.
Example
-------
Here’s an example document that defines metadata for serveral articles:
``` javascript
{
"title": "Hello World",
"date": "2012-08-09",
"tags": [ "hello world", "misc" ]
}
---
{
"title": "The second article",
"date": "2012-08-10",
"tags": [ "misc" ]
}
```
Note that each object is a normal JSON representation of a JavaScript object.
In pure JSON, the same document would look like this:
``` javascript
[
{
"title": "Hello World",
"date": "2012-08-09",
"tags": [ "hello world", "misc" ]
},
{
"title": "The second article",
"date": "2012-08-10",
"tags": [ "misc" ]
}
]
```
So the only difference from a usual JSON document is, that objects in top level
arrays are separated by `---` on a distinct line.
Installation
------------
```
npm install jsml
```
or
```
ender build jsml
```
Usage
-----
You can use JSML just like [JSON](https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/JSON):
``` javascript
var JSML = require('jsml');
var jsmlDocument = '{ "title": "Hello World",\n'
+ '"date": "2012-08-09",\n'
+ '"tags": [ "hello world", "misc" ] }\n'
+ '---\n'
+ '{ "title": "The second article",\n'
+ '"date": "2012-08-10",\n'
+ '"tags": [ "misc" ] }\n';
// Parse a string
var doc = JSML.parse(jsmlDocument);
console.log(doc);
// Stringify an Object or an Array of Objects
var jsmlString = JSML.stringify(doc, null, ' ');
console.log(jsmlString);
```
This will print:
``` javascript
[ { title: 'Hello World',
date: '2012-08-09',
tags: [ 'hello world', 'misc' ] },
{ title: 'The second article',
date: '2012-08-10',
tags: [ 'misc' ] } ]
```
for the parsed string and the following for the _stringified_ array:
``` javascript
{
"title": "Hello World",
"date": "2012-08-09",
"tags": [
"hello world",
"misc"
]
}
---
{
"title": "The second article",
"date": "2012-08-10",
"tags": [
"misc"
]
}
```
Bugs and Issues
---------------
If you encounter any bugs or issues, feel free to
[open an issue](https://github.com/pvorb/jsml/issues) at github.
License
-------
Copyright © 2012 Paul Vorbach
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.