Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bimedia-fr/node-sigma-message

simple key-value message parser and formater
https://github.com/bimedia-fr/node-sigma-message

Last synced: 8 days ago
JSON representation

simple key-value message parser and formater

Awesome Lists containing this project

README

        

node-sigma-message
==================

simple key-value message parser and formater

introduction
------------
Format and parses string containing key-value pairs.

synopsis
--------

```javascript
var parser = require('sigma-message')();

var obj = parser.parse('key=value;other=val');
console.log(obj);
// outputs {key:value,other:val}
```

installation
------------

$ npm install sigma-message

API
===

parser(config)
----------------
The constructor function creates a new `parser`. Optionnal parameter `options` allow to change separator and delimiter.
`config` :

* `delimiter` : default is ';'
* `separator` : default is '='

.parse(string)
------------------------------------
Parse a string and return an objet containing key and values.

.format(obj)
------------------------------------
Returns a string containing parameters properties and values.