ioredis/built/types.d.ts

A robust, performance-focused and full-featured Redis client for Node.js.

/// <reference types="node" />
/// <reference types="node" />
/// <reference types="node" />
/// <reference types="node" />
import { Socket } from "net";
import { TLSSocket } from "tls";
export type Callback<T = any> = (err?: Error | null, result?: T) => void;
export type NetStream = Socket | TLSSocket;
export type ProtocolVersion = 2 | 3;
export type ReplyMappingMode = "legacy" | "resp3";
export type ReplyMappingFromOptions<Current extends ReplyMappingMode, Options> = Options extends {
    replyMapping: infer Mapping;
} ? Extract<Mapping, ReplyMappingMode> extends never ? Current : Extract<Mapping, ReplyMappingMode> : Current;
export type ReplyMappingFromClusterOptions<Current extends ReplyMappingMode, Options> = Options extends {
    redisOptions: {
        replyMapping: infer Mapping;
    };
} ? Extract<Mapping, ReplyMappingMode> extends never ? Current : Extract<Mapping, ReplyMappingMode> : Current;
export type CommandParameter = string | Buffer | number | any[];
export interface Respondable {
    name: string;
    args: CommandParameter[];
    resolve(result: any): void;
    reject(error: Error): void;
}
export interface PipelineWriteableStream {
    isPipeline: true;
    write(data: string | Buffer): unknown;
    destination: {
        redis: {
            stream: NetStream;
        };
    };
}
export type WriteableStream = NetStream | PipelineWriteableStream;
export interface CommandItem {
    command: Respondable;
    stream: WriteableStream;
    select: number;
}
export interface ScanStreamOptions {
    match?: string;
    type?: string;
    count?: number;
    noValues?: boolean;
}