mirror of
https://codeberg.org/tacerus/teddit.git
synced 2025-01-09 04:42:35 +01:00
52 lines
1.5 KiB
Markdown
52 lines
1.5 KiB
Markdown
|
# Redis Commands
|
||
|
|
|
||
|
|
[](https://travis-ci.org/NodeRedis/redis-commands)
|
||
|
|
[](https://codeclimate.com/github/NodeRedis/redis-commands)
|
||
|
|
[](https://codeclimate.com/github/NodeRedis/redis-commands/coverage)
|
||
|
|
|
||
|
|
This module exports all the commands that Redis supports.
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
```shell
|
||
|
|
$ npm install redis-commands
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var commands = require('redis-commands');
|
||
|
|
```
|
||
|
|
|
||
|
|
`.list` is an array contains all the lowercased commands:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
commands.list.forEach(function (command) {
|
||
|
|
console.log(command);
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
`.exists()` is used to check if the command exists:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
commands.exists('set') // true
|
||
|
|
commands.exists('other-command') // false
|
||
|
|
```
|
||
|
|
|
||
|
|
`.hasFlag()` is used to check if the command has the flag:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
commands.hasFlag('set', 'readonly') // false
|
||
|
|
```
|
||
|
|
|
||
|
|
`.getKeyIndexes()` is used to get the indexes of keys in the command arguments:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
commands.getKeyIndexes('set', ['key', 'value']) // [0]
|
||
|
|
commands.getKeyIndexes('mget', ['key1', 'key2']) // [0, 1]
|
||
|
|
```
|
||
|
|
|
||
|
|
## Acknowledgment
|
||
|
|
|
||
|
|
Thank [@Yuan Chuan](https://github.com/yuanchuan) for the package name. The original redis-commands is renamed to [@yuanchuan/redis-commands](https://www.npmjs.com/package/@yuanchuan/redis-commands).
|