Skip to content

ErrorService

katanakit-js / ErrorService

Defined in: core/services/error.service.ts:32

ErrorService — Singleton facade over error creation and normalization.

Applies the Singleton pattern (one shared instance via ErrorService.getInstance) and the Facade pattern: each public method hides the status-code message defaults and the raw-error mapping behind one call. Everything is pure — no state, no I/O — so the instance is safe to share across environments (Node, Bun, browser, SSR).

Every public method uses the use* prefix per CONTRIBUTING.md; the module level use* functions below are thin wrappers kept for call-site ergonomics.

import { useErrorCustom } from "katanakit-js";
const error = useErrorCustom("User not found", 404);
// { message: "User not found", code: 404 }
useErrorCustom(msg, code): {
code: number;
message: string;
};

Defined in: core/services/error.service.ts:86

Create a custom error object. Use with useLogger for consistent error logging.

Parameter Type Description
msg string Error message
code number HTTP status code
{
code: number;
message: string;
}

Serialized error with message and code

code: number;
message: string;
import { useErrorCustom, useLogger } from "katanakit-js";
const error = useErrorCustom("User not found", 404);
useLogger(error.message, error, "error");
// { message: "User not found", code: 404 }

useErrorNormalize(error, fallbackStatus?): {
details?: unknown;
message: string;
status: number;
};

Defined in: core/services/error.service.ts:109

Normalizes any thrown value into the shared ApiError shape.

Reads message, numeric status (or statusCode, used by some SDKs) and details when present; every other value becomes a generic error. This is the canonical mapper for useAttempt() at service boundaries.

Parameter Type Default value Description
error unknown undefined The caught value (Error, SDK error object, string, …).
fallbackStatus? number 0 Status used when the value has none (default: 0).
{
details?: unknown;
message: string;
status: number;
}

A serializable { message, status, details? } error.

details?: unknown;
message: string;
status: number;
import { useAttempt, useErrorNormalize } from "katanakit-js";
const result = await useAttempt(() => sdk.call(), useErrorNormalize);
if (!result.ok) console.error(result.error.status, result.error.message);

useErrorSerialize(message?, code?): {
code: number;
message: string;
};

Defined in: core/services/error.service.ts:63

Serialize an error into a plain object. Uses sensible defaults based on the status code when message is omitted.

Parameter Type Default value Description
message? string "" Error message (falls back to status code default)
code? number 400 HTTP status code (default: 400)
{
code: number;
message: string;
}

Serialized error with message and code

code: number;
message: string;
const err = useErrorSerialize("User not found", 404);
// { message: "User not found", code: 404 }
const err2 = useErrorSerialize("", 500);
// { message: "Internal Server Error", code: 500 }

static getInstance(): ErrorService;

Defined in: core/services/error.service.ts:39

Returns the shared instance (Singleton).

ErrorService