@serverduty/http-errors v0.1.3

http-errors

@serverduty/http-errors offers a straightforward and efficient way to handle HTTP errors in your Express applications, making your code cleaner and more maintainable.

Usage

Importing the Package

You can import the entire set of HTTP error functions or individual functions based on your requirements.

Importing All Functions

import httpErrors from '@serverduty/http-errors'

With this import, you can use any of the error functions using the httpErrors object:

app.get('/example', (req, res) => {
  // Use any error function
  httpErrors.notFound(res, { message: 'This is a 404 error message' })
})

Importing Individual Functions

import { notFound, unauthorized } from '@serverduty/http-errors'

This allows you to use only the imported functions:

app.get('/example', (req, res) => {
  // Directly use the imported function
  notFound(res, { message: 'Not Found Error' })
})

Using Error Functions in Express

The error functions are designed to be used in an Express application. Here's how you can use them in your routes or middleware:

app.get('/user/:id', (req, res) => {
  const user = getUserById(req.params.id)
  if (!user) {
    return httpErrors.notFound(res, { message: 'User not found' })
  }
  res.json(user)
})

app.post('/login', (req, res) => {
  const { username, password } = req.body
  if (!authenticate(username, password)) {
    return httpErrors.unauthorized(res, { message: 'Invalid credentials' })
  }
  // proceed with login logic
})

Customizing Error Messages

You can pass a custom message or additional data as the second argument to any error function:

app.get('/restricted', (req, res) => {
  if (!req.user.isAdmin) {
    return httpErrors.forbidden(res, { message: 'Access denied', reason: 'Not an admin' })
  }
  // continue with admin-only logic
})

This flexibility allows you to provide more context in your error responses, making them more informative for the client.

Supported Error Functions

License

The MIT License (MIT)

Copyright 2023 ServerDuty Limited

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.