Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/wankdanker/node-redis-key


https://github.com/wankdanker/node-redis-key

Last synced: 14 days ago
JSON representation

Awesome Lists containing this project

README

        

redis-key
---------

Redis key generator / function argument joiner

This module is basically a shortcut for:

```js
Array.prototype.slice.call(arguments).join(separator);
```

install
-------

```bash
npm install redis-key
```

example
-------

```js
var rk = require('redis-key');

//default separator is ':'
var key = rk('product-collection', 'company', 'price-level');
//key = "product-collection:company:price-level"
```

### Setting a default separator

```js
var rk = require('redis-key').defaults('/');

//now the separator is '/'
var key = rk('part', 1, 3);
//key = "part/1/3"
```

api
---

### .defaults([separator, [prefix]])

* separator - [string] the character[s] to put between the tokens that make up your key (default ':')
* prefix - [string] an additional token that is prefixed to the key

motivation
----------

I've been generating redis keys like this:

```js
var key = ['part1', var1, var2, var3].join(':');
```

I thought it would be more concise to be able to do this:

```js
var key = k('part1', var1, var2, var3);
```

And if my math is correct, it is more concise by 9 whole characters. Joy.

license
-------

MIT