redis-errors

What is redis-errors?

The redis-errors npm package provides a set of custom error classes for handling Redis-related errors in a more structured and meaningful way. It helps developers to catch and handle specific Redis errors more effectively.

What are redis-errors's main functionalities?

Custom Error Classes

The package provides custom error classes like ReplyError, AbortError, ParserError, and AggregateError. These classes help in identifying and handling specific types of Redis errors.

const { ReplyError, AbortError, ParserError, AggregateError } = require('redis-errors');

try {
  // Simulate a Redis operation that throws an error
  throw new ReplyError('This is a reply error');
} catch (error) {
  if (error instanceof ReplyError) {
    console.error('Caught a ReplyError:', error.message);
  }
}

Error Handling

The package allows for structured error handling by checking the instance of the error and responding accordingly. This makes it easier to debug and manage Redis-related errors.

const { ReplyError, AbortError, ParserError, AggregateError } = require('redis-errors');

function handleError(error) {
  if (error instanceof ReplyError) {
    console.error('ReplyError:', error.message);
  } else if (error instanceof AbortError) {
    console.error('AbortError:', error.message);
  } else if (error instanceof ParserError) {
    console.error('ParserError:', error.message);
  } else if (error instanceof AggregateError) {
    console.error('AggregateError:', error.message);
  } else {
    console.error('Unknown error:', error.message);
  }
}

try {
  // Simulate a Redis operation that throws an error
  throw new AbortError('This is an abort error');
} catch (error) {
  handleError(error);
}

Other packages similar to redis-errors

ioredis

ioredis is a robust, full-featured Redis client for Node.js. It provides built-in error handling for various Redis errors, but it does not offer the same level of custom error classes as redis-errors. Instead, it focuses on providing a comprehensive set of features for interacting with Redis.

node-redis

node-redis is another popular Redis client for Node.js. It includes basic error handling capabilities but lacks the specialized custom error classes provided by redis-errors. It is designed to be simple and easy to use for basic Redis operations.

README

redis-errors

All error classes used in node_redis from v.3.0.0 are in here. They can be required as needed.

Install

Install with NPM:

npm install redis-errors

Usage

const { RedisError, ReplyError } = require('redis-errors');

// Using async await
try {
  return client.set('foo') // Missing value
} catch (err) {
  if (err instanceof ReplyError) {
    console.log(err)
  }
  throw err
}

Error classes

• RedisError sub class of Error
• ReplyError sub class of RedisError
• ParserError sub class of RedisError

All Redis errors will be returned as ReplyErrors while a parser error is returned as ParserError.

License

MIT