RedisAdapter

@tsed/adapters-redis

Usage

import { RedisAdapter } from "@tsed/adapters-redis";

See /packages/orm/adapters-redis/src/adapters/RedisAdapter.ts.

Overview

class RedisAdapter<Model extends AdapterModel> extends Adapter<Model> {
    readonly hooks: Hooks;
    readonly connectionName: string;
    readonly connection: RedisConnection;
    readonly keyPrefix: string;
    protected useHash: boolean;
    constructor(options: RedisAdapterConstructorOptions);
    get db(): Redis;
    key(id: string): string;
    create(payload: Partial<Model>, expiresAt?: Date): Promise<Model>;
    upsert(id: string, payload: Model, expiresAt?: Date): Promise<Model>;
    update(id: string, payload: Model, expiresAt?: Date): Promise<Model | undefined>;
    updateOne(predicate: Partial<Model & any>, payload: Model, expiresAt?: Date): Promise<Model | undefined>;
    findOne(predicate: Partial<Model & any>): Promise<Model | undefined>;
    findById(_id: string): Promise<Model | undefined>;
    findAll(predicate?: Partial<Model & any>): Promise<Model[]>;
    deleteOne(predicate: Partial<Model & any>): Promise<Model | undefined>;
    deleteById(_id: string): Promise<Model | undefined>;
    deleteMany(predicate: Partial<Model>): Promise<Model[]>;
    prefix(key: string): string;
    protected callCmd(target: any, methods: string[], ...args: any[]): any;
    protected extractIdFromIndexedKey(key: string): string | undefined;
    protected findKeys(props: any): Promise<string[]>;
    protected insert(payload: Partial<Model>, expiresAt?: Date): Promise<any>;
    protected getAllIndex(id: string): Promise<string[]>;
    protected getIndexedKey(id: string, propertyKey: string, value: any): string;
    protected getAll(): Promise<Model[]>;
    protected findAllBy(props: Partial<Model & any>): Promise<Model[]>;
}

readonly hooks

readonly hooks: Hooks;

readonly connectionName

readonly connectionName: string;

readonly connection

readonly connection: RedisConnection;

readonly keyPrefix

readonly keyPrefix: string;

protected useHash

protected useHash: boolean;

get db

get db(): Redis;

key

key(id: string): string;

create

create(payload: Partial<Model>, expiresAt?: Date): Promise<Model>;

upsert

upsert(id: string, payload: Model, expiresAt?: Date): Promise<Model>;

update

update(id: string, payload: Model, expiresAt?: Date): Promise<Model | undefined>;

updateOne

updateOne(predicate: Partial<Model & any>, payload: Model, expiresAt?: Date): Promise<Model | undefined>;

findOne

findOne(predicate: Partial<Model & any>): Promise<Model | undefined>;

findById

findById(_id: string): Promise<Model | undefined>;

findAll

findAll(predicate?: Partial<Model & any>): Promise<Model[]>;

deleteOne

deleteOne(predicate: Partial<Model & any>): Promise<Model | undefined>;

deleteById

deleteById(_id: string): Promise<Model | undefined>;

deleteMany

deleteMany(predicate: Partial<Model>): Promise<Model[]>;

prefix

prefix(key: string): string;

protected callCmd

protected callCmd(target: any, methods: string[], ...args: any[]): any;

protected extractIdFromIndexedKey

protected extractIdFromIndexedKey(key: string): string | undefined;

protected findKeys

protected findKeys(props: any): Promise<string[]>;

protected insert

protected insert(payload: Partial<Model>, expiresAt?: Date): Promise<any>;

protected getAllIndex

protected getAllIndex(id: string): Promise<string[]>;

protected getIndexedKey

protected getIndexedKey(id: string, propertyKey: string, value: any): string;

protected getAll

protected getAll(): Promise<Model[]>;

protected findAllBy

protected findAllBy(props: Partial<Model & any>): Promise<Model[]>;