Sermone

Sermone, a Redis protocol encoder for commands.

Try Syllabus a collection of mix-ins for Redis commands, builded upon Sermone.encode.

Install

$ npm install sermone [-g]
// clone repo
$ git clone [email protected]:rootslab/sermone.git

require returns an hash/obj.

var Sermone  = require( 'sermone' );

Run Tests

$ cd sermone/
$ npm test

Run Benchmark

$ cd sermone/
$ npm run bench

Sample Usage

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

See examples.

Methods

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

/*
 * 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

MIT License

Copyright (c) 2013-present < Guglielmo Ferri : [email protected] >

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.