@polymathnetwork/launchpad-redis

launchpad-redis

Setup redis instance:

RUN docker pull redis/redis-stack

RUN docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 -e REDIS_ARGS="--requirepass mypassword" redis/redis-stack:latest

The docker run command above also exposes RedisInsight on port 8001. You can use RedisInsight by pointing your browser to http://localhost:8001

Redis client Usage:

const client = createRedisClient({
    url: 'redis://:mypassword@localhost:6379',
  });

  await client.connect();

  try {
    await client.set('key', 'value');
  } catch (error: any) {
    logger.error(`SET ERROR: ${error.message}`);
  }

  try {
    const result = await client.get('key');
    logger.info(`GET RESULT: ${result}`);
  } catch (error: any) {
    logger.error(`GET ERROR: ${error.message}`);
  }

Client configuration options:

connection: {
    retryDelay: number;
    maxRetries?: number;
  };
  commands: {
    readCommandTimeout?: number;
  };
  scripts: LuaScriptDefinition[];
  disableOfflineQueue: boolean;

retryDelay (in ms): Attempt reconnection with redis server after retryAttemptNumber*retryDelay

maxRetires: terminate redis client if connection to redis server fails after this number of retries

readCommandTimeout (in ms): read commands fail to resolve if this much time has passed without a response from the redis server

scripts: lua srcipts that will loaded onto redis and executable by calling client.<script-name>

disableOfflineQueue: determines whether or not commands are queued when the client is disconnected. If set to true, commands sent while the client is offline will be discarded instead of being queued for execution when the connection is restored. This can be useful to prevent unexpected behavior or memory issues in cases where the application should not continue processing commands during downtime.