Node-Redis 技术文档

1. 安装指南

首先，确保您已经安装了Docker，因为我们将使用Docker来启动Redis服务。您可以使用以下命令来启动Redis：

docker run -p 6379:6379 -it redis/redis-stack-server:latest

接下来，使用npm安装Node-Redis：

npm install redis

2. 项目的使用说明

Node-Redis是一个现代化的高性能Redis客户端，适用于Node.js。以下是一个基本的使用示例：

import { createClient } from 'redis';

const client = await createClient()
  .on('error', err => console.log('Redis Client Error', err))
  .connect();

await client.set('key', 'value');
const value = await client.get('key');
await client.disconnect();

如果要连接到不同的主机或端口，可以使用格式为redis[s]://[[username][:password]@][host][:port][/db-number]的连接字符串。

3. 项目API使用文档

Node-Redis支持所有Redis的内置命令。这些命令可以通过原始的Redis命令名（如HSET、HGETALL等）或者更友好的驼峰式JavaScript命令名（如hSet、hGetAll等）来使用。

// 原始Redis命令
await client.HSET('key', 'field', 'value');
await client.HGETALL('key');

// 友好的JavaScript命令
await client.hSet('key', 'field', 'value');
await client.hGetAll('key');

可以使用JavaScript对象来指定命令的修饰符：

await client.set('key', 'value', {
  EX: 10,
  NX: true
});

回复将被转换为有用的数据结构：

await client.hGetAll('key'); // { field1: 'value1', field2: 'value2' }
await client.hVals('key'); // ['value1', 'value2']

Buffer也被支持：

await client.hSet('key', 'field', Buffer.from('value')); // 'OK'
await client.hGetAll(
  commandOptions({ returnBuffers: true }),
  'key'
); // { field: <Buffer 76 61 6c 75 65> }

4. 项目安装方式

请参照“安装指南”部分中提供的步骤来安装Node-Redis。首先，确保Docker已正确安装，然后使用Docker启动Redis服务，最后通过npm安装Node-Redis模块。