47ng / 47ng/fastify-micro

RFC-7807 for errors

Open
#415 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
46
Forks
4
PR merge metrics
No merged PRs in 30d

Description

In combination with `fastify.sensible`, make it easy to send well-formatted errors to clients, with actionable details for better DX.

Specification: https://tools.ietf.org/html/rfc7807

Copy-pasta from another project:
```ts
// https://tools.ietf.org/html/rfc7807

import { STATUS_CODES } from 'node:http'
import { z } from 'zod'

export const rfc7807Schema = z.object({
status: z
.number()
.int()
.refine(code => code in STATUS_CODES),
type: z.string().url().optional(), // Technically a URI, but let's not split hairs
title: z.string(),
detail: z.string().optional(),
instance: z.string().url().optional()
})

export type RFC7807 = z.TypeOf

export class RFC7807Error extends Error {
readonly rfc7807: RFC7807

constructor(args: RFC7807) {
super(
`${STATUS_CODES[args.status]}: ${args.title}${
args.detail ? ` (${args.detail})` : ''
}`
)
this.name = 'RFC7807Error'
this.rfc7807 = {
...args,
type: args.type ?? 'about:blank'
}
}
}
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.