sermone

$3


!NODE VERSION

!NPM YEARLY


> _Sermone_, a __Redis__ protocol encoder for commands.

> Try __Syllabus__ a collection of mix-ins for __Redis__ commands, builded upon _Sermone.encode_.

$3

``bash
$ npm install sermone [-g]
// clone repo
$ git clone git@github.com:rootslab/sermone.git
`

> __require__ returns an hash/obj.

`javascript
var Sermone = require( 'sermone' );
`

$3

`bash
$ cd sermone/
$ npm test
`

$3

`bash
$ cd sermone/
$ npm run bench
`

$3

`javascript
var Sermone = require( 'sermone' );
Sermone.encode( 'CMD', 'KEY', [ 1, 2, 3 ], function () {} );
`
> See examples.

$3

> Arguments within [ ] are optional, '|' indicates multiple type for an argument.

`javascript
/*
* Encode a Redis command.
*
* NOTE: 'cmd' and 'key' arguments should be strings, however,
* for convenience, 'key' is converted to String before encoding,
* then you can use Numbers for keys without problems.
*
* It returns an hash:
* {
* bulks : Number
* , cmd : String
* , ecmd : String | Buffer ( RESTORE cmd )
* , fn : Function
* , zn : Function
* }
*/
Sermone#encode( String cmd [, Function fn [, Function zn ] ] ) : Object

Sermone#encode( String cmd [, String key [, Function fn [, Function zn ] ] ] ) : Object

Sermone#encode( String cmd [, String key [, Object object [, Function fn [, Function zn ] ] ] ] ) : Object

Sermone#encode( String cmd [, String key [, Array array [, Function fn [, Function zn ] ] ] ] ) : Object

``

------------------------------------------------------------------------

$3

> Copyright (c) 2013-present < Guglielmo Ferri : 44gatti@gmail.com >

> 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, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
> SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.