-first commit
This commit is contained in:
43
node_modules/@ioredis/commands/README.md
generated
vendored
Normal file
43
node_modules/@ioredis/commands/README.md
generated
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
# Redis Commands
|
||||
|
||||
This module exports all the commands that Redis supports.
|
||||
|
||||
## Install
|
||||
|
||||
```shell
|
||||
$ npm install @ioredis/commands
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const commands = require('@ioredis/commands');
|
||||
```
|
||||
|
||||
`.list` is an array contains all the lowercased commands:
|
||||
|
||||
```js
|
||||
commands.list.forEach((command) => {
|
||||
console.log(command);
|
||||
});
|
||||
```
|
||||
|
||||
`.exists()` is used to check if the command exists:
|
||||
|
||||
```js
|
||||
commands.exists('set') // true
|
||||
commands.exists('other-command') // false
|
||||
```
|
||||
|
||||
`.hasFlag()` is used to check if the command has the flag:
|
||||
|
||||
```js
|
||||
commands.hasFlag('set', 'readonly') // false
|
||||
```
|
||||
|
||||
`.getKeyIndexes()` is used to get the indexes of keys in the command arguments:
|
||||
|
||||
```js
|
||||
commands.getKeyIndexes('set', ['key', 'value']) // [0]
|
||||
commands.getKeyIndexes('mget', ['key1', 'key2']) // [0, 1]
|
||||
```
|
||||
Reference in New Issue
Block a user