redis.adapter.md

RedisAdapter

This class is a basic redis database adapter.

Interface

export type KVType = "raw" | "object";

export type StringOrObject = string | Record<string, any>;

export interface GetConnectionPerfResponse {
  isAlive: boolean;
  perf: number;
}

export interface ClearExpiredOptions {
  banTimeInSecond: number;
}

export type RedisIsKeyExpiredOptions = ClearExpiredOptions & {
  key: KeyType;
};

export interface RedisSetValueOptions<T extends StringOrObject = Record<string, any>> {
  key: KeyType;
  value: Partial<T>;
  type: KVType;
  expiresIn?: number;
}

export type RedisAdapterOptions = Partial<RedisOptions> & {
  attempt?: number;
  disconnectionTimeout?: number;
};

Constants

const kDefaultAttempt = 4;
const kDefaultTimeout = 500;

📚 Usage

import { RedisAdapter } from "@myunisoft/redis";

const redisAdapter = new RedisAdapter();

📜 API

constructor< T extends StringOrObject = Record< string, any > >(options: RedisAdapterOptions = {})

setValue(options: RedisSetValueOptions): Promise< Result< KeyType, SetValueError > >

this method is used to set a key-value pair in redis

const key = "foo";
const value = {
  foo: "bar",
};

await redisAdapter.setValue({ key, value });

getValue(key: KeyType, type: KVType): Promise< T | null >

this method is used to get a value from redis

const key = "foo";

const result = await redisAdapter.getValue(key);

console.log(result); // { foo: "bar" }

deleteValue(key: KeyType): Promise< number >

this method is used to delete a key-value pair in redis

const key = "foo";

const result = await redisAdapter.deleteValue(key);

console.log(result); // 0 for Failure, 1 for Success