cloudflare-toolkit

Appearance

@adrianhall/cloudflare-toolkit

@adrianhall/cloudflare-toolkit / index / NullError

Class: NullError ​

Defined in: src/lib/errors/null-error.ts:12

A specialized internalServerError()-shaped ProblemDetailsError for an unexpected null/undefined value. Exists as a distinct, named error class so guard functions (throwIfNull, sqlCount) have a single, greppable call site — it is still handled uniformly by problemDetailsErrorHandler because it remains a ProblemDetailsError.

Extends ​

Constructors ​

Constructor ​

new NullError(message): NullError

Defined in: src/lib/errors/null-error.ts:18

Create a new NullError.

Parameters ​

message ​

string

Human-readable explanation of what was unexpectedly null/undefined.

Returns ​

NullError

Overrides ​

ProblemDetailsError.constructor

Properties ​

cause? ​

optional cause?: unknown

Defined in: docs/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from ​

ProblemDetailsError.cause

message ​

message: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from ​

ProblemDetailsError.message

name ​

name: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from ​

ProblemDetailsError.name

problemDetails ​

readonly problemDetails: ProblemDetails

Defined in: src/lib/problem-details/error.ts:14

The normalized RFC 9457 Problem Details object.

Inherited from ​

ProblemDetailsError.problemDetails

stack? ​

optional stack?: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from ​

ProblemDetailsError.stack

stackTraceLimit ​

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from ​

ProblemDetailsError.stackTraceLimit

Methods ​

getResponse() ​

getResponse(): Response

Defined in: src/lib/problem-details/error.ts:35

Build a standalone application/problem+json Response without any Hono handler middleware.

Returns ​

Response

The resulting Response.

Inherited from ​

ProblemDetailsError.getResponse

captureStackTrace() ​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters ​

targetObject ​

object

constructorOpt? ​

Function

Returns ​

void

Inherited from ​

ProblemDetailsError.captureStackTrace

prepareStackTrace() ​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters ​

err ​

Error

stackTraces ​

CallSite[]

Returns ​

any

See ​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from ​

ProblemDetailsError.prepareStackTrace