phanx-redis v0.1.6

Redis wrapper adding promise and typescript support.

Features

• Provided Typescript source code.
• Exposes all REDIS commands and wraps them with promises.
• Provides two helper methods for searching and looping through values: getSearch and delSearch.

install

Requirements

• ECMAScript 2016 (ES6)
• Node.JS 6.x or later (tested on 6.11)

Basic Example

Helper Methods exclusive to this module:

getDefault(key,defaultValue)

Just like the standard .get(key) method, but instead will allow you to provide a default value if the key is not found or is null.

getJson(key)

Will attempt to automatically parse the JSON and return the object.

setJson(key, object)

Will attempt to convert passed in object to JSON and save to key.

getSearch(key, callback(key,value,cbnext) )

This method allows you to loop over key/values that match your search criteria. Internally it uses the SCAN redis command.

Alternatively, you can return the search result in a Dictionary (dictionaryjs) collection and use all the great dictionaryjs methods to iterate through it.

delSearch(key)

This method is similar to the getSearch method, but instead of allowing you to loop through the results, it deletes them, and then returns the delete count.

multi() Functionality

Multi allows commands to be queued together, and ensures that all commands succeed or all fail.

.mutli() chaining functionality is not supported by this module. You may access its functionality by not chaining it. Such as:

Error Handling

You can disable errors being thrown and handle errors by checking if an error existed in the previous operation.

Otherwise, by default throwErrors is true, and thus you will need to handle errors using try/catch.

Based on node_redis

This module wraps the node_redis module. Please review this module for more information about what methods and commands are available to you.