Skip to content

@adrianhall/cloudflare-toolkit


@adrianhall/cloudflare-toolkit / index / createProblemTypeRegistry

Function: createProblemTypeRegistry()

createProblemTypeRegistry<K>(definitions): ProblemTypeRegistry<K>

Defined in: src/lib/problem-details/registry.ts:61

Create a registry of pre-defined problem types. Provides type-safe error creation from registered definitions.

Type Parameters

K

K extends string

Parameters

definitions

Record<K, ProblemTypeDefinition>

A map of problem type keys to their base definition (type, status, title).

Returns

ProblemTypeRegistry<K>

A ProblemTypeRegistry for the given definitions.

Example

ts
const problems = createProblemTypeRegistry({
  ORDER_CONFLICT: {
    type: "https://api.example.com/problems/order-conflict",
    status: 409,
    title: "Order Conflict",
  },
});
throw problems.create("ORDER_CONFLICT", { detail: "Already exists" });