HTTP
The http module provides two enums: HttpStatusCode for standard HTTP response codes, and HttpMethod for standard HTTP request methods.
Import
import { HttpStatusCode, HttpMethod } from '@open-kerno/commons/http';
HttpStatusCode
An enum with all standard HTTP status codes grouped by category.
1xx — Informational
| Member | Value |
|---|---|
CONTINUE | 100 |
SWITCHING_PROTOCOLS | 101 |
PROCESSING | 102 |
EARLY_HINTS | 103 |
2xx — Success
| Member | Value |
|---|---|
OK | 200 |
CREATED | 201 |
ACCEPTED | 202 |
NON_AUTHORITATIVE_INFORMATION | 203 |
NO_CONTENT | 204 |
RESET_CONTENT | 205 |
PARTIAL_CONTENT | 206 |
MULTI_STATUS | 207 |
ALREADY_REPORTED | 208 |
IM_USED | 226 |
3xx — Redirection
| Member | Value |
|---|---|
MULTIPLE_CHOICES | 300 |
MOVED_PERMANENTLY | 301 |
FOUND | 302 |
SEE_OTHER | 303 |
NOT_MODIFIED | 304 |
TEMPORARY_REDIRECT | 307 |
PERMANENT_REDIRECT | 308 |
4xx — Client Errors
| Member | Value |
|---|---|
BAD_REQUEST | 400 |
UNAUTHORIZED | 401 |
PAYMENT_REQUIRED | 402 |
FORBIDDEN | 403 |
NOT_FOUND | 404 |
METHOD_NOT_ALLOWED | 405 |
NOT_ACCEPTABLE | 406 |
PROXY_AUTHENTICATION_REQUIRED | 407 |
REQUEST_TIMEOUT | 408 |
CONFLICT | 409 |
GONE | 410 |
LENGTH_REQUIRED | 411 |
PRECONDITION_FAILED | 412 |
PAYLOAD_TOO_LARGE | 413 |
URI_TOO_LONG | 414 |
UNSUPPORTED_MEDIA_TYPE | 415 |
RANGE_NOT_SATISFIABLE | 416 |
EXPECTATION_FAILED | 417 |
IM_A_TEAPOT | 418 |
MISDIRECTED_REQUEST | 421 |
UNPROCESSABLE_ENTITY | 422 |
LOCKED | 423 |
FAILED_DEPENDENCY | 424 |
TOO_EARLY | 425 |
UPGRADE_REQUIRED | 426 |
PRECONDITION_REQUIRED | 428 |
TOO_MANY_REQUESTS | 429 |
REQUEST_HEADER_FIELDS_TOO_LARGE | 431 |
UNAVAILABLE_FOR_LEGAL_REASONS | 451 |
5xx — Server Errors
| Member | Value |
|---|---|
INTERNAL_ERROR | 500 |
NOT_IMPLEMENTED | 501 |
BAD_GATEWAY | 502 |
SERVICE_UNAVAILABLE | 503 |
GATEWAY_TIMEOUT | 504 |
HTTP_VERSION_NOT_SUPPORTED | 505 |
VARIANT_ALSO_NEGOTIATES | 506 |
INSUFFICIENT_STORAGE | 507 |
LOOP_DETECTED | 508 |
NOT_EXTENDED | 510 |
NETWORK_AUTHENTICATION_REQUIRED | 511 |
Example
import { HttpStatusCode } from '@open-kerno/commons/http';
res.status(HttpStatusCode.CREATED).json({ id: newUser.id });
res.status(HttpStatusCode.NOT_FOUND).json({ message: 'User not found' });
HttpMethod
An enum with all standard HTTP request methods.
| Member | Value |
|---|---|
GET | 'GET' |
POST | 'POST' |
PUT | 'PUT' |
PATCH | 'PATCH' |
DELETE | 'DELETE' |
HEAD | 'HEAD' |
OPTIONS | 'OPTIONS' |
TRACE | 'TRACE' |
CONNECT | 'CONNECT' |
Example
import { HttpMethod } from '@open-kerno/commons/http';
const allowedMethods = [HttpMethod.GET, HttpMethod.POST];
if (!allowedMethods.includes(req.method as HttpMethod)) {
res.status(405).end();
}