Sections

@calvinbonner/minifw API Reference

Version 0.2.1

helpers/error

class MiniHttpError

class MiniHttpError extends Error {
  constructor(status: number, message: string): MiniHttpError;
  cause?: unknown;
  message: string;
  name: string;
  stack?: string;
  readonly status: number;
  stackTraceLimit: number;
  captureStackTrace(targetObject: object, constructorOpt?: Function): void;
  captureStackTrace(targetObject: object, constructorOpt?: Function): void;
  isError(error: unknown): error;
  isError(value: unknown): value;
  prepareStackTrace(err: Error, stackTraces: CallSite[]): any;
}

Error type used by MiniFW to represent HTTP errors.

constructor constructor

constructor(status: number, message: string): MiniHttpError

property cause

The cause of the error.

unknown

property message

string

property name

string

property stack

string

property status

number

property stackTraceLimit

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.

number

method captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void

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

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:

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();
captureStackTrace(targetObject: object, constructorOpt?: Function): void

Create .stack property on a target object

method isError

isError(error: unknown): error

Indicates whether the argument provided is a built-in Error instance or not.

isError(value: unknown): value

Check if a value is an instance of Error

value

The value to check

Returns:

True if the value is an instance of Error, false otherwise

method prepareStackTrace

prepareStackTrace(err: Error, stackTraces: CallSite[]): any

function error

error(status: number, message: string): never

Throw an HTTP error to abort rendering.

status

HTTP status code in the 4xx or 5xx range.

message

Error message returned to the client.

function isMiniError

isMiniError(value: unknown): value

Check whether an unknown value is a MiniFW error.

value

Value to check.

Returns:

True if the value is a MiniHttpError.