@fastify/error

A small utility, used by Fastify itself, for generating consistent error objects across your codebase and plugins.

Install

npm i @fastify/error

Usage

The module exports a function that you can use for consistent error objects, it takes 4 parameters:

createError(code, message [, statusCode [, Base [, captureStackTrace]]])

• code (string, required) - The error code, you can access it later with error.code. For consistency, we recommend prefixing plugin error codes with FST_
• message (string, required) - The error message. You can also use interpolated strings for formatting the message.
• statusCode (number, optional) - The status code that Fastify will use if the error is sent via HTTP.
• Base (ErrorConstructor, optional) - The base error object that will be used. (eg TypeError, RangeError)
• captureStackTrace (boolean, optional) - Whether to capture the stack trace or not.

1const createError = require('@fastify/error')
2const CustomError = createError('ERROR_CODE', 'Hello')
3console.log(new CustomError()) // error.message => 'Hello'

How to use an interpolated string:

1const createError = require('@fastify/error')
2const CustomError = createError('ERROR_CODE', 'Hello %s')
3console.log(new CustomError('world')) // error.message => 'Hello world'

How to add cause:

1const createError = require('@fastify/error')
2const CustomError = createError('ERROR_CODE', 'Hello %s')
3console.log(new CustomError('world', {cause: new Error('cause')}))
4// error.message => 'Hello world'
5// error.cause => Error('cause')

TypeScript

It is possible to limit your error constructor with a generic type using TypeScript:

1const CustomError = createError<[string]>('ERROR_CODE', 'Hello %s')
2new CustomError('world')
3//@ts-expect-error
4new CustomError(1)

License

Licensed under MIT.