Start and stop a Redis server.
npm install redis-server
Start and stop a local Redis server in Node.js like a boss.
``Bash
npm install redis-server
`
The constructor exported by this module optionally accepts a single argument;
a number or string that is a port or an object for configuration.
`JavaScript
const RedisServer = require('redis-server');
// Simply pass the port that you want a Redis server to listen on.
const server = new RedisServer(6379);
server.open((err) => {
if (err === null) {
// You may now connect a client to the Redis
// server bound to port 6379.
}
});
`
| Property | Type | Default | Description
|:---------|:-------|:-------------|:-----------
| bin | String | redis-server | A Redis server binary path.
| conf | String | | A Redis server configuration file path.
| port | Number | 6379 | A port to bind a Redis server to.
| slaveof | String | | An address of a Redis server to sync with.
A Redis server binary must be available. If you do not have one in $PATH,
provide a path in configuration.
`JavaScript
const server = new RedisServer({
port: 6379,
bin: '/opt/local/bin/redis-server'
});
`
You may use a Redis configuration file instead of configuration object
properties that are flags (i.e. port and slaveof). If conf is
provided, no flags will be passed to the binary.
`JavaScript
const server = new RedisServer({
conf: '/path/to/redis.conf'
});
`
For methods that accept callback, callback will receive an Error
as the first argument if a problem is detected; , if not.
#### RedisServer#open()
Attempt to open a Redis server. Returns a Promise.
##### Promise style open()
` JavaScript
server.open().then(() => {
// You may now connect a client to the Redis server bound to server.port.
});
`
##### Callback style open()
` JavaScript
server.open((err) => {
if (err === null) {
// You may now connect a client to the Redis server bound to server.port.
}
});
`
#### RedisServer#close()
Close the associated Redis server. Returns a Promise. NOTE: Disconnect
clients prior to calling this method to avoid receiving connection
errors from clients.
##### Promise style close()
` JavaScript
server.close().then(() => {
// The associated Redis server is now closed.
});
`
##### Callback style close()
` JavaScript
server.close((err) => {
// The associated Redis server is now closed.
});
`
#### RedisServer#isOpening
Determine if the instance is starting a Redis server; true while a
process is spawning, and/or about to be spawned, until the contained Redis
server either starts or errs.
#### RedisServer#isRunning
Determine if the instance is running a Redis server; true once a process
has spawned and the contained Redis server is ready to service requests.
#### RedisServer#isClosing
Determine if the instance is closing a Redis server; true` while a
process is being, or about to be, killed until the contained Redis server either
closes or errs.
#### stdout
Emitted when a Redis server prints to stdout.
#### opening
Emitted when attempting to start a Redis server.
#### open
Emitted when a Redis server becomes ready to service requests.
#### closing
Emitted when attempting to stop a Redis server.
#### close
Emitted once a Redis server has stopped.