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.
If fastify-error is installed multiple times directly or as a transitive dependency, instanceof checks for errors created by createError will still work correctly across these installations, as long as their error codes (e.g., FST_ERR_CUSTOM_ERROR) are identical.
const { createError, FastifyError } = require('@fastify/error')// CustomError from `@fastify/some-plugin` is created with `createError` and// has its own `@fastify/error` installation as dependency. CustomError has// FST_ERR_CUSTOM_ERROR as code.const { CustomError: CustomErrorFromPlugin } = require('@fastify/some-plugin')const CustomError = createError('FST_ERR_CUSTOM_ERROR', 'Hello %s', 500)const customError = new CustomError('world')const customErrorFromPlugin = new CustomErrorFromPlugin('world')console.log(customError instanceof CustomError) // true
Changing the code of an instantiated Error will not change the result of the instanceof operator.