@qnx/errors

@qnx/errors is providing components to simplify your codes.

Installation

Use the package manager npm to install @qnx/errors.

npm install @qnx/errors

You can also use yarn & pnpm

yarn add @qnx/errors

pnpm install @qnx/errors

Usage

import { ApiError, ValidationError, InvalidValueError, UnauthenticatedUserError, ServerError } from '@qnx/errors';

# Creating a custom error instance
const validationError = new ValidationError('Custom error message', { errRes: { errors: { email: ['Invalid email'] } } });

# Creating a single error instance
const invalidValueError = new InvalidValueError('Invalid email address.', { key:'email' });


Handling validation errors
try {
  // ... perform validation
} catch (err) {
  const validationError = new ValidationError('Validation failed', { errors: err.errors });
  // ... handle validation error
}

Handling server errors
try {
  // ... perform server action
} catch (err) {
  const serverError = new ServerError('Server error occurred');
  // ... handle server error
}

ApiError: An optional object that contains additional information about the error. This object should follow the structure of the ErrorResponse interface. This class provides two methods:

getCode(): Returns the HTTP error code. getErrorResponse(): Returns the error response object. ValidationError This class is used to represent validation errors. It inherits from the ApiError class and takes two parameters:

message: A string that describes the validation error. errorResponse: An object that contains validation error message. This object should follow the structure of the ApiResponseErrors type. UnauthenticatedUserError This class represents errors that occur when a user is not authenticated. It inherits from the ApiError class and takes one parameter:

message: A string that describes the unauthenticated user error. ServerError This class is used to represent errors that occur on the server side. It inherits from the ApiError class and takes one parameter:

message: A string that describes the server error.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

License

MIT License © 2023-PRESENT Yatendra Kushwaha