@handy-common-utils/misc-utils
Version:
Miscellaneous utilities
129 lines • 8.98 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.HttpStatusMessage = exports.HttpStatusCode = void 0;
/**
* Some (not all) well known HTTP status codes
*/
var HttpStatusCode;
(function (HttpStatusCode) {
/**
* The request has succeeded. The meaning of a success varies depending on the HTTP method:
* GET: The resource has been fetched and is transmitted in the message body.
* HEAD: The entity headers are in the message body.
* POST: The resource describing the result of the action is transmitted in the message body.
* TRACE: The message body contains the request message as received by the server
*/
HttpStatusCode[HttpStatusCode["OK200"] = 200] = "OK200";
/**
* The request has succeeded and a new resource has been created as a result of it. This is typically the response sent after a PUT request.
*/
HttpStatusCode[HttpStatusCode["CREATED201"] = 201] = "CREATED201";
/**
* The request has been received but not yet acted upon. It is non-committal, meaning that there is no way in HTTP to later send an asynchronous response indicating the outcome of processing the request. It is intended for cases where another process or server handles the request, or for batch processing.
*/
HttpStatusCode[HttpStatusCode["ACCEPTED202"] = 202] = "ACCEPTED202";
/**
* There is no content to send for this request, but the headers may be useful. The user-agent may update its cached headers for this resource with the new ones.
*/
HttpStatusCode[HttpStatusCode["NO_CONTENT204"] = 204] = "NO_CONTENT204";
/**
* This response code means that URI of requested resource has been changed. Probably, new URI would be given in the response.
*/
HttpStatusCode[HttpStatusCode["MOVED_PERMANENTLY301"] = 301] = "MOVED_PERMANENTLY301";
/**
* This response code means that URI of requested resource has been changed temporarily. New changes in the URI might be made in the future. Therefore, this same URI should be used by the client in future requests.
*/
HttpStatusCode[HttpStatusCode["MOVED_TEMPORARILY302"] = 302] = "MOVED_TEMPORARILY302";
/**
* Server sent this response to directing client to get requested resource to another URI with an GET request.
*/
HttpStatusCode[HttpStatusCode["SEE_OTHER303"] = 303] = "SEE_OTHER303";
/**
* Server sent this response to directing client to get requested resource to another URI with same method that used prior request. This has the same semantic than the 302 Found HTTP response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the second request.
*/
HttpStatusCode[HttpStatusCode["TEMPORARY_REDIRECT307"] = 307] = "TEMPORARY_REDIRECT307";
/**
* This means that the resource is now permanently located at another URI, specified by the Location: HTTP Response header. This has the same semantics as the 301 Moved Permanently HTTP response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the second request.
*/
HttpStatusCode[HttpStatusCode["PERMANENT_REDIRECT308"] = 308] = "PERMANENT_REDIRECT308";
/**
* This response means that server could not understand the request due to invalid syntax.
*/
HttpStatusCode[HttpStatusCode["BAD_REQUEST400"] = 400] = "BAD_REQUEST400";
/**
* Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
*/
HttpStatusCode[HttpStatusCode["UNAUTHORIZED401"] = 401] = "UNAUTHORIZED401";
/**
* The client does not have access rights to the content, i.e. they are unauthorized, so server is rejecting to give proper response. Unlike 401, the client's identity is known to the server.
*/
HttpStatusCode[HttpStatusCode["FORBIDDEN403"] = 403] = "FORBIDDEN403";
/**
* The server can not find requested resource. In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. This response code is probably the most famous one due to its frequent occurence on the web.
*/
HttpStatusCode[HttpStatusCode["NOT_FOUND404"] = 404] = "NOT_FOUND404";
/**
* The request method is known by the server but has been disabled and cannot be used. For example, an API may forbid DELETE-ing a resource. The two mandatory methods, GET and HEAD, must never be disabled and should not return this error code.
*/
HttpStatusCode[HttpStatusCode["METHOD_NOT_ALLOWED405"] = 405] = "METHOD_NOT_ALLOWED405";
/**
* This response is sent on an idle connection by some servers, even without any previous request by the client. It means that the server would like to shut down this unused connection. This response is used much more since some browsers, like Chrome, Firefox 27+, or IE9, use HTTP pre-connection mechanisms to speed up surfing. Also note that some servers merely shut down the connection without sending this message.
*/
HttpStatusCode[HttpStatusCode["REQUEST_TIMEOUT408"] = 408] = "REQUEST_TIMEOUT408";
/**
* This response is sent when a request conflicts with the current state of the server.
*/
HttpStatusCode[HttpStatusCode["CONFLICT409"] = 409] = "CONFLICT409";
/**
* The user has sent too many requests in a given amount of time ("rate limiting").
*/
HttpStatusCode[HttpStatusCode["TOO_MANY_REQUESTS429"] = 429] = "TOO_MANY_REQUESTS429";
/**
* The server encountered an unexpected condition that prevented it from fulfilling the request.
*/
HttpStatusCode[HttpStatusCode["INTERNAL_SERVER_ERROR500"] = 500] = "INTERNAL_SERVER_ERROR500";
/**
* The request method is not supported by the server and cannot be handled. The only methods that servers are required to support (and therefore that must not return this code) are GET and HEAD.
*/
HttpStatusCode[HttpStatusCode["NOT_IMPLEMENTED501"] = 501] = "NOT_IMPLEMENTED501";
/**
* This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response.
*/
HttpStatusCode[HttpStatusCode["BAD_GATEWAY502"] = 502] = "BAD_GATEWAY502";
/**
* The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded. Note that together with this response, a user-friendly page explaining the problem should be sent. This responses should be used for temporary conditions and the Retry-After: HTTP header should, if possible, contain the estimated time before the recovery of the service. The webmaster must also take care about the caching-related headers that are sent along with this response, as these temporary condition responses should usually not be cached.
*/
HttpStatusCode[HttpStatusCode["SERVICE_UNAVAILABLE503"] = 503] = "SERVICE_UNAVAILABLE503";
/**
* This error response is given when the server is acting as a gateway and cannot get a response in time.
*/
HttpStatusCode[HttpStatusCode["GATEWAY_TIMEOUT504"] = 504] = "GATEWAY_TIMEOUT504";
})(HttpStatusCode || (exports.HttpStatusCode = HttpStatusCode = {}));
/**
* Some (not all) HTTP status messages matching their codes
*/
exports.HttpStatusMessage = {
[]: 'OK',
[]: 'Created',
[]: 'Accepted',
[]: 'No Content',
[]: 'Moved Permanently',
[]: 'Moved Temporarily',
[]: 'See Other',
[]: 'Temporary Redirect',
[]: 'Permanent Redirect',
[]: 'Bad Request',
[]: 'Unauthorized',
[]: 'Forbidden',
[]: 'Not Found',
[]: 'Method Not Allowed',
[]: 'Request Timeout',
[]: 'Conflict',
[]: 'Too Many Requests',
[]: 'Internal Server Error',
[]: 'Not Implemented',
[]: 'Bad Gateway',
[]: 'Service Unavailable',
[]: 'Gateway Timeout',
};
//# sourceMappingURL=http-status.js.map