Sections

@calvinbonner/minifw API Reference

Version 0.2.1

helpers/redirect-to

class MiniRedirect

class MiniRedirect extends Error {
  constructor(url: string | URL, status: number): MiniRedirect;
  cause?: unknown;
  message: string;
  name: string;
  readonly response: Response;
  stack?: string;
  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;
}

Internal control-flow signal used by redirectTo.

constructor constructor

constructor(url: string | URL, status: number): MiniRedirect

property cause

The cause of the error.

unknown

property message

string

property name

string

property response

Response

property stack

string

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 isMiniRedirect

isMiniRedirect(value: unknown): value

Check whether an unknown value is a MiniFW render-time redirect.

value

Value to check.

Returns:

True if the value is a MiniRedirect.

function redirectTo

redirectTo(url: string | URL, status: number): never

Abort rendering and redirect the client.

Use redirect from minifw/core when a redirect is used directly as a route entry.

url

The destination URL.

status

The redirect status code. Defaults to 302.