mirror of
https://github.com/feathersjs/feathers.git
synced 2026-01-25 15:23:13 +00:00
feathers-errors
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: 400NotAuthenticated: 401PaymentError: 402Forbidden: 403NotFound: 404MethodNotAllowed: 405NotAcceptable: 406Timeout: 408Conflict: 409Unprocessable: 422GeneralError: 500NotImplemented: 501Unavailable: 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'} });
Release History
1.2.0
- Adding error handler and basic static error pages back in
1.1.2
- Adding more tests
- Adding even more flexibility for handling multiple errors
1.1.1
- Fixing critical bug #15
1.1.0
- Adding better support for multiple errors
1.0.0
- converting to ES6
- making structure consistent with other plugins
- removing error handlers #11
0.2.0
- Adding support for mongoose errors Issue #5.
0.1.4
- Adding more error types
- Changing
missingtofourOhFour - Making library feathers core compatible
0.1.3
- Adding a default error page
0.1.2
- Minor bug fixes
0.1.1
- Exposing error types directly via
var types = require('feathers-errors').types;
0.1.0
- Initial release
License
Copyright (c) 2015 Feathers Contributors
Licensed under the MIT license.
