# @types/redis-parser

> TypeScript definitions for redis-parser

Latest version **3.0.3** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/redis-parser
pnpm add @types/redis-parser
yarn add @types/redis-parser
bun add @types/redis-parser
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.3 |
| Published | 2023-11-07 |
| First published | 2021-08-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51449 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/redis-parser
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/redis-parser
- npm.io page: https://npm.io/package/@types/redis-parser

## Dependencies (2)

- [@types/node](https://npm.io/package/@types/node.md) *
- [@types/redis-errors](https://npm.io/package/@types/redis-errors.md) *

## Recent versions

- 3.0.3 (latest) — 2023-11-07
- 3.0.0 (ts3.6) — 2021-08-04
- 3.0.2 — 2023-10-18
- 3.0.1 — 2023-09-27

## README

# 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](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/redis-parser/index.d.ts)
````ts
/// <reference types="node" />

import { ParserError, RedisError, ReplyError } from "redis-errors";

/**
 * RedisParserOptions
 */
interface RedisParserOptions {
    /** returnReply */
    returnReply(reply: any): void;
    /** returnError */
    returnError(err: RedisError): void;
    /** optional, defaults to the `returnError` function */
    returnFatalError?(err: ParserError): void;
    /** All strings are returned as Buffer e.g. <Buffer 48 65 6c 6c 6f>. optional, defaults to false */
    returnBuffers?: boolean;
    /** All numbers are returned as String. optional, defaults to false */
    stringNumbers?: boolean;
}

/**
 * Javascript Redis Parser
 */
declare class JavascriptRedisParser {
    constructor(options: RedisParserOptions);
    /** Private fields  */
    private offset;
    private buffer;
    private bigStrSize;
    private totalChunkSize;
    private bufferCache;
    private arrayCache;
    private arrayPos;
    private returnReply(reply: any): void;
    private returnError(err: ReplyError): void;
    private returnFatalError(err: ParserError): void;
    /**
     * Reset the parser values to the initial state
     */
    reset(): void;
    readonly optionReturnBuffers: boolean;
    /**
     * Set the returnBuffers option
     */
    setReturnBuffers(returnBuffers: boolean): void;

    readonly optionStringNumbers: boolean;
    /**
     * Set the stringNumbers option
     */
    setStringNumbers(stringNumbers: boolean): void;
    /**
     * Parse the redis buffer
     */
    execute(buffer: Buffer): void;
}

export = JavascriptRedisParser;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node), [@types/redis-errors](https://npmjs.com/package/@types/redis-errors)

# Credits
These definitions were written by [OpportunityLiu](https://github.com/OpportunityLiu).

---
_Source: https://npm.io/package/@types/redis-parser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._