Installation

npm install --save @types/redis-parser

Summary

This package contains type definitions for redis-parser (https://github.com/NodeRedis/node-redis-parser).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/redis-parser.

index.d.ts

1/// <reference types="node" />
2
3import { ParserError, RedisError, ReplyError } from "redis-errors";
4
5/**
6 * RedisParserOptions
7 */
8interface RedisParserOptions {
9    /** returnReply */
10    returnReply(reply: any): void;
11    /** returnError */
12    returnError(err: RedisError): void;
13    /** optional, defaults to the `returnError` function */
14    returnFatalError?(err: ParserError): void;
15    /** All strings are returned as Buffer e.g. <Buffer 48 65 6c 6c 6f>. optional, defaults to false */
16    returnBuffers?: boolean;
17    /** All numbers are returned as String. optional, defaults to false */
18    stringNumbers?: boolean;
19}
20
21/**
22 * Javascript Redis Parser
23 */
24declare class JavascriptRedisParser {
25    constructor(options: RedisParserOptions);
26    /** Private fields  */
27    private offset;
28    private buffer;
29    private bigStrSize;
30    private totalChunkSize;
31    private bufferCache;
32    private arrayCache;
33    private arrayPos;
34    private returnReply(reply: any): void;
35    private returnError(err: ReplyError): void;
36    private returnFatalError(err: ParserError): void;
37    /**
38     * Reset the parser values to the initial state
39     */
40    reset(): void;
41    readonly optionReturnBuffers: boolean;
42    /**
43     * Set the returnBuffers option
44     */
45    setReturnBuffers(returnBuffers: boolean): void;
46
47    readonly optionStringNumbers: boolean;
48    /**
49     * Set the stringNumbers option
50     */
51    setStringNumbers(stringNumbers: boolean): void;
52    /**
53     * Parse the redis buffer
54     */
55    execute(buffer: Buffer): void;
56}
57
58export = JavascriptRedisParser;
59

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: @types/node, @types/redis-errors

Credits

These definitions were written by OpportunityLiu.