AFFiNE-Mirror/packages/backend/server/src/base/redis/config.ts

import { RedisOptions } from 'ioredis';
import { z } from 'zod';

import { defineModuleConfig } from '../config';

declare global {
  interface AppConfigSchema {
    redis: {
      host: string;
      port: number;
      db: number;
      username: string;
      password: string;
      ioredis: ConfigItem<
        Omit<RedisOptions, 'host' | 'port' | 'db' | 'username' | 'password'>
      >;
    };
  }
}

defineModuleConfig('redis', {
  db: {
    desc: 'The database index of redis server to be used(Must be less than 10).',
    default: 0,
    env: ['REDIS_SERVER_DATABASE', 'integer'],
    shape: z.number().int().nonnegative().max(10),
  },
  host: {
    desc: 'The host of the redis server.',
    default: 'localhost',
    env: ['REDIS_SERVER_HOST', 'string'],
  },
  port: {
    desc: 'The port of the redis server.',
    default: 6379,
    env: ['REDIS_SERVER_PORT', 'integer'],
    shape: z.number().positive(),
  },
  username: {
    desc: 'The username of the redis server.',
    default: '',
    env: ['REDIS_SERVER_USERNAME', 'string'],
  },
  password: {
    desc: 'The password of the redis server.',
    default: '',
    env: ['REDIS_SERVER_PASSWORD', 'string'],
  },
  ioredis: {
    desc: 'The config for the ioredis client.',
    default: {},
    link: 'https://github.com/luin/ioredis',
  },
});