/status.ts | oak_commons@1.0.0

import * as oakCommons from "https://deno.land/x/oak_commons@1.0.0/status.ts";

Contains the STATUS_CODE object which contains standard HTTP status codes and provides several type guards for handling status codes with type safety.

Examples

Example 1

import {
  STATUS_CODE,
  STATUS_TEXT,
} from "jsr:@oak/commons/status";

console.log(STATUS_CODE.NotFound); // Returns 404
console.log(STATUS_TEXT[STATUS_CODE.NotFound]); // Returns "Not Found"

Example 2

import { isErrorStatus } from "jsr:@oak/commons/status";

const res = await fetch("https://example.com/");

if (isErrorStatus(res.status)) {
  // error handling here...
}

Enums

Status

Standard HTTP status codes.

Variables

v STATUS_CODE	A constant hash of all the standard HTTP status codes.
v STATUS_TEXT	A record of all the status codes text.

Functions

f isClientErrorStatus	A type guard that determines if the status code is a client error.
f isErrorStatus	A type guard that determines if the status code is an error.
f isInformationalStatus	A type guard that determines if the status code is informational.
f isRedirectStatus	A type guard that determines if the status code is a redirection.
f isServerErrorStatus	A type guard that determines if the status code is a server error.
f isStatus	A type guard that determines if the value is a valid `StatusCode`.
f isSuccessfulStatus	A type guard that determines if the status code is successful.

Type Aliases

T ClientErrorStatus	An HTTP status that is a client error (4XX).
T ErrorStatus	An HTTP status that is an error (4XX and 5XX).
T InformationalStatus	An HTTP status that is a informational (1XX).
T RedirectStatus	An HTTP status that is a redirect (3XX).
T ServerErrorStatus	An HTTP status that is a server error (5XX).
T StatusCode
T StatusText	A type alias which is a set of string literal types of all the status text values.
T SuccessfulStatus	An HTTP status that is a success (2XX).