feathers-errors

Common error types for feathers apps

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
feathers-errors
3602.9.26 years ago9 years agoMinified + gzip package size for feathers-errors in KB

Readme

feathers-errors
Greenkeeper badge
Build Status Code Climate Test Coverage Dependency Status Download Status Slack Status
Common error types for feathers apps

Getting Started

Feathers errors come with feathers by default. So typically you don't need to install it at all.
In the event that you do need to install it:
npm install --save feathers-errors

Documentation

Current Error Types:

  • BadRequest: 400
  • NotAuthenticated: 401
  • PaymentError: 402
  • Forbidden: 403
  • NotFound: 404
  • MethodNotAllowed: 405
  • NotAcceptable: 406
  • Timeout: 408
  • Conflict: 409
  • LengthRequired: 411
  • Unprocessable: 422
  • TooManyRequests: 429
  • GeneralError: 500
  • NotImplemented: 501
  • BadGateway: 502
  • Unavailable: 503

Pro Tip: Feathers service adapters (ie. mongodb, memory, etc.) already emit the appropriate errors for you. :-)

Usage:

import errors from 'feathers-errors';

// If you were to create an error yourself.
var notFound = new errors.NotFound('User does not exist');

// You can wrap existing errors
var existing = new errors.GeneralError(new Error('I exist'));

// You can also pass additional data
var data = new errors.BadRequest('Invalid email', {email: 'sergey@google.com'});

// You can also pass additional data
var dataWithoutMessage = new errors.BadRequest({email: 'sergey@google.com'});

// If you need to pass multiple errors
var validationErrors = new errors.BadRequest('Invalid Parameters', {errors: {email: 'Email already taken'} });

// You can also omit the error message and we'll put in a default one for you
var validationErrors = new errors.BadRequest({errors: {email: 'Invalid Email'} });

License

Copyright (c) 2016 Feathers Contributors
Licensed under the MIT license.