@std/http@0.215.0

latest

Works with

•JSR Score70%•

Published2 years ago (0.215.0)

@std/http

status

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 "@std/http/status";

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

Example 2

import { isErrorStatus } from "@std/http/status";

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

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

Functions

isClientErrorStatus(status: number): status is ClientErrorStatus

A type guard that determines if the status code is a client error.

isErrorStatus(status: number): status is ErrorStatus

A type guard that determines if the status code is an error.

isInformationalStatus(status: number): status is InformationalStatus

A type guard that determines if the status code is informational.

isRedirectStatus(status: number): status is RedirectStatus

A type guard that determines if the status code is a redirection.

isServerErrorStatus(status: number): status is ServerErrorStatus

A type guard that determines if the status code is a server error.

isStatus(status: number): status is StatusCode

Returns whether the provided number is a valid HTTP status code.

isSuccessfulStatus(status: number): status is SuccessfulStatus

A type guard that determines if the status code is successful.

Type Aliases

ClientErrorStatus =

An HTTP status that is a client error (4XX).

ErrorStatus = ClientErrorStatus | ServerErrorStatus

An HTTP status that is an error (4XX and 5XX).

InformationalStatus =

STATUS_CODE.Continue
| STATUS_CODE.SwitchingProtocols
| STATUS_CODE.Processing
| STATUS_CODE.EarlyHints

An HTTP status that is a informational (1XX).

RedirectStatus =

An HTTP status that is a redirect (3XX).

ServerErrorStatus =

An HTTP status that is a server error (5XX).

StatusCode = STATUS_CODE[keyof STATUS_CODE]

An HTTP status code.

StatusText = STATUS_TEXT[keyof STATUS_TEXT]

An HTTP status text.

SuccessfulStatus =

An HTTP status that is a success (2XX).

Variables

STATUS_CODE: { Continue: number; SwitchingProtocols: number; Processing: number; EarlyHints: number; OK: number; Created: number; Accepted: number; NonAuthoritativeInfo: number; NoContent: number; ResetContent: number; PartialContent: number; MultiStatus: number; AlreadyReported: number; IMUsed: number; MultipleChoices: number; MovedPermanently: number; Found: number; SeeOther: number; NotModified: number; UseProxy: number; TemporaryRedirect: number; PermanentRedirect: number; BadRequest: number; Unauthorized: number; PaymentRequired: number; Forbidden: number; NotFound: number; MethodNotAllowed: number; NotAcceptable: number; ProxyAuthRequired: number; RequestTimeout: number; Conflict: number; Gone: number; LengthRequired: number; PreconditionFailed: number; ContentTooLarge: number; URITooLong: number; UnsupportedMediaType: number; RangeNotSatisfiable: number; ExpectationFailed: number; Teapot: number; MisdirectedRequest: number; UnprocessableEntity: number; Locked: number; FailedDependency: number; TooEarly: number; UpgradeRequired: number; PreconditionRequired: number; TooManyRequests: number; RequestHeaderFieldsTooLarge: number; UnavailableForLegalReasons: number; InternalServerError: number; NotImplemented: number; BadGateway: number; ServiceUnavailable: number; GatewayTimeout: number; HTTPVersionNotSupported: number; VariantAlsoNegotiates: number; InsufficientStorage: number; LoopDetected: number; NotExtended: number; NetworkAuthenticationRequired: number; }

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

Accepted: number
No documentation available
AlreadyReported: number
No documentation available
BadGateway: number
No documentation available
BadRequest: number
No documentation available
Conflict: number
No documentation available
ContentTooLarge: number
No documentation available
Continue: number
No documentation available
Created: number
No documentation available
EarlyHints: number
No documentation available
ExpectationFailed: number
No documentation available
FailedDependency: number
No documentation available
Forbidden: number
No documentation available
Found: number
No documentation available
GatewayTimeout: number
No documentation available
Gone: number
No documentation available
HTTPVersionNotSupported: number
No documentation available
IMUsed: number
No documentation available
InsufficientStorage: number
No documentation available
InternalServerError: number
No documentation available
LengthRequired: number
No documentation available
Locked: number
No documentation available
LoopDetected: number
No documentation available
MethodNotAllowed: number
No documentation available
MisdirectedRequest: number
No documentation available
MovedPermanently: number
No documentation available
MultiStatus: number
No documentation available
MultipleChoices: number
No documentation available
NetworkAuthenticationRequired: number
No documentation available
NoContent: number
No documentation available
NonAuthoritativeInfo: number
No documentation available
NotAcceptable: number
No documentation available
NotExtended: number
No documentation available
NotFound: number
No documentation available
NotImplemented: number
No documentation available
NotModified: number
No documentation available
OK: number
No documentation available
PartialContent: number
No documentation available
PaymentRequired: number
No documentation available
PermanentRedirect: number
No documentation available
PreconditionFailed: number
No documentation available
PreconditionRequired: number
No documentation available
Processing: number
No documentation available
ProxyAuthRequired: number
No documentation available
RangeNotSatisfiable: number
No documentation available
RequestHeaderFieldsTooLarge: number
No documentation available
RequestTimeout: number
No documentation available
ResetContent: number
No documentation available
SeeOther: number
No documentation available
ServiceUnavailable: number
No documentation available
SwitchingProtocols: number
No documentation available
Teapot: number
No documentation available
TemporaryRedirect: number
No documentation available
TooEarly: number
No documentation available
TooManyRequests: number
No documentation available
URITooLong: number
No documentation available
Unauthorized: number
No documentation available
UnavailableForLegalReasons: number
No documentation available
UnprocessableEntity: number
No documentation available
UnsupportedMediaType: number
No documentation available
UpgradeRequired: number
No documentation available
UseProxy: number
No documentation available
VariantAlsoNegotiates: number
No documentation available

STATUS_TEXT: { [[STATUS_CODE.Accepted]]: string; [[STATUS_CODE.AlreadyReported]]: string; [[STATUS_CODE.BadGateway]]: string; [[STATUS_CODE.BadRequest]]: string; [[STATUS_CODE.Conflict]]: string; [[STATUS_CODE.Continue]]: string; [[STATUS_CODE.Created]]: string; [[STATUS_CODE.EarlyHints]]: string; [[STATUS_CODE.ExpectationFailed]]: string; [[STATUS_CODE.FailedDependency]]: string; [[STATUS_CODE.Forbidden]]: string; [[STATUS_CODE.Found]]: string; [[STATUS_CODE.GatewayTimeout]]: string; [[STATUS_CODE.Gone]]: string; [[STATUS_CODE.HTTPVersionNotSupported]]: string; [[STATUS_CODE.IMUsed]]: string; [[STATUS_CODE.InsufficientStorage]]: string; [[STATUS_CODE.InternalServerError]]: string; [[STATUS_CODE.LengthRequired]]: string; [[STATUS_CODE.Locked]]: string; [[STATUS_CODE.LoopDetected]]: string; [[STATUS_CODE.MethodNotAllowed]]: string; [[STATUS_CODE.MisdirectedRequest]]: string; [[STATUS_CODE.MovedPermanently]]: string; [[STATUS_CODE.MultiStatus]]: string; [[STATUS_CODE.MultipleChoices]]: string; [[STATUS_CODE.NetworkAuthenticationRequired]]: string; [[STATUS_CODE.NoContent]]: string; [[STATUS_CODE.NonAuthoritativeInfo]]: string; [[STATUS_CODE.NotAcceptable]]: string; [[STATUS_CODE.NotExtended]]: string; [[STATUS_CODE.NotFound]]: string; [[STATUS_CODE.NotImplemented]]: string; [[STATUS_CODE.NotModified]]: string; [[STATUS_CODE.OK]]: string; [[STATUS_CODE.PartialContent]]: string; [[STATUS_CODE.PaymentRequired]]: string; [[STATUS_CODE.PermanentRedirect]]: string; [[STATUS_CODE.PreconditionFailed]]: string; [[STATUS_CODE.PreconditionRequired]]: string; [[STATUS_CODE.Processing]]: string; [[STATUS_CODE.ProxyAuthRequired]]: string; [[STATUS_CODE.ContentTooLarge]]: string; [[STATUS_CODE.RequestHeaderFieldsTooLarge]]: string; [[STATUS_CODE.RequestTimeout]]: string; [[STATUS_CODE.URITooLong]]: string; [[STATUS_CODE.RangeNotSatisfiable]]: string; [[STATUS_CODE.ResetContent]]: string; [[STATUS_CODE.SeeOther]]: string; [[STATUS_CODE.ServiceUnavailable]]: string; [[STATUS_CODE.SwitchingProtocols]]: string; [[STATUS_CODE.Teapot]]: string; [[STATUS_CODE.TemporaryRedirect]]: string; [[STATUS_CODE.TooEarly]]: string; [[STATUS_CODE.TooManyRequests]]: string; [[STATUS_CODE.Unauthorized]]: string; [[STATUS_CODE.UnavailableForLegalReasons]]: string; [[STATUS_CODE.UnprocessableEntity]]: string; [[STATUS_CODE.UnsupportedMediaType]]: string; [[STATUS_CODE.UpgradeRequired]]: string; [[STATUS_CODE.UseProxy]]: string; [[STATUS_CODE.VariantAlsoNegotiates]]: string; }

A record of all the status codes text.

Add Package

deno add jsr:@std/http

Import symbol

import * as mod from "@std/http/status";

Import directly with a jsr specifier

import * as mod from "jsr:@std/http/status";