https://github.com/estrada9166/graphql-custom-error-response
Create custom errors response
https://github.com/estrada9166/graphql-custom-error-response
express graphql graphql-api graphql-express graphql-js graphql-server nodejs
Last synced: 8 months ago
JSON representation
Create custom errors response
- Host: GitHub
- URL: https://github.com/estrada9166/graphql-custom-error-response
- Owner: estrada9166
- License: mit
- Created: 2018-04-08T04:34:09.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-08T04:48:34.000Z (about 8 years ago)
- Last Synced: 2025-05-28T17:07:20.986Z (about 1 year ago)
- Topics: express, graphql, graphql-api, graphql-express, graphql-js, graphql-server, nodejs
- Language: JavaScript
- Size: 115 KB
- Stars: 12
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Create custom error response
[](http://makeapullrequest.com)
# Step by step
[Check this post to try it step by step](https://medium.com/@estrada9166/return-custom-errors-with-status-code-on-graphql-45fca360852)
# How to run it
+ Clone this repo.
+ `npm install`.
+ `npm run dev`.
+ Visit on your browser `http://localhost:7000/graphql`.
+ Make this query:
```
{
test {
test
}
}
```
## Main idea
The main idea is to return a custom error with the `statusCode` on the response, also you can send any extra field, to do it you need to change just 2 files:
### Constants.js
```js
exports.errorType = {
UNAUTHORIZED: {
message: 'Authentication is needed to get requested response.',
statusCode: 401
// add here any extra field
}
}
```
### App.js
```js
formatError: (err) => {
const error = getErrorCode(err.message)
return ({
message: error.message,
statusCode: error.statusCode
// add here err.
})
}
```
In this case we just want to return a `message` and a `statusCode`
## License
### The MIT License
Copyright (c) 2018 Alejandro Estrada
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.