redis-phrase-complete

A redis autocomplete library that allows phrase search

Installation

npm install redis-phrase-complete

Usage

const RedisPhraseComplete = require('redis-phrase-complete')

const redisPhraseComplete = new RedisPhraseComplete({ 
    namespace: 'AutoCompleteTest',
    port: 6379, 
    host: 'localhost',
    endpoint: 'redis://localhost:6379', 
    client: redis.createClient...
})

redisPhraseComplete.whenAdd('The quick brown fox jumps over the lazy dog', '1')
                   .then(() => redisPhraseComplete.whenFind('brown fox'))
                   .then(console.log)
                   .then(redisPhraseComplete.whenQuit)                   

Api

new RedisPhraseComplete(options)

If options aren't passed, it uses defaults.

• namespace: The namespace used for the phrasecomplete index. The default is 'AutoComplete'.
• port: Port address for the redis instance. The default is 6379.
• host: The hostname for the redis instance. The default is localhost.
• endpoint: Add the full endpoint for redis, an alternative to setting port and hostname.
• client: Use to pass in your own client.

whenAdd(sentence, id)

Indexes the phrases of the sentence to find the id.

whenRemove(sentence, id)

Removes the indexing of the id from the phrases of the sentence.

whenRemoveAll()

Removes all entries under the namespace passed into the constructor.

whenFind(searchPhrase)

Returns all ids and the original sentences that the phrase is part of, uses a searchPhrase* pattern.

whenQuit()

Call this to quit the redis connection when you are done unless you are passing in your own client.