@js-thing/http-status-codes
Version:
Contains properly documented HTTP status code enums, reason phrases and helpers as defined in RFC
139 lines (138 loc) • 5.39 kB
TypeScript
/**
* Enum for HTTP server error response status codes
*
* The values can range from (500–599)
*
* @readonly
* @enum {number}
*/
declare enum HttpServerErrorStatusCodes {
/**
* ### 500 Internal Server Error
*
* The server has encountered a situation it doesn't know how to handle.
*
* [Read more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) |
* [Official Documentation](https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1)
* @type {number}
*/
InternalServerError = 500,
/**
* ### 501 Not Implemented
*
* 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`.
*
* [Read more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/501) |
* [Official Documentation](https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.2)
* @type {number}
*/
NotImplemented = 501,
/**
* ### 502 Bad Gateway
*
* 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.
*
* [Read more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) |
* [Official Documentation](https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.3)
* @type {number}
*/
BadGateway = 502,
/**
* ### 503 Service Unavailable
*
* 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.
*
* [Read more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) |
* [Official Documentation](https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.4)
* @type {number}
*/
ServiceUnavailable = 503,
/**
* ### 504 Gateway Timeout
*
* This error response is given when the server is acting as
* a gateway and cannot get a response in time.
*
* [Read more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) |
* [Official Documentation](https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.5)
* @type {number}
*/
GatewayTimeout = 504,
/**
* ### 505 HTTP Version Not Supported
*
* The HTTP version used in
* the request is not supported by the server.
*
* [Read more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/505) |
* [Official Documentation](https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.6)
* @type {number}
*/
HTTPVersionNotSupported = 505,
/**
* ### 506 Variant Also Negotiates
*
* The server has an internal configuration error: the chosen variant
* resource is configured to engage in transparent content negotiation itself,
* and is therefore not a proper end point in the negotiation process.
*
* [Read more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/506) |
* [Official Documentation](https://datatracker.ietf.org/doc/html/rfc2295#section-8.1)
* @type {number}
*/
VariantAlsoNegotiates = 506,
/**
* ### 507 Insufficient Storage (WebDAV)
*
* The method could not be performed on the resource because the server is
* unable to store the representation needed to successfully complete the request.
*
* [Read more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/507) |
* [Official Documentation](https://datatracker.ietf.org/doc/html/rfc2518#section-10.6)
* @type {number}
*/
InsufficientStorage = 507,
/**
* ### 508 Loop Detected (WebDAV)
*
* The server detected an infinite loop while processing the request.
*
* [Read more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/508) |
* [Official Documentation](https://datatracker.ietf.org/doc/html/rfc5842#section-7.2)
* @type {number}
*/
LoopDetected = 508,
/**
* ### 510 Not Extended
*
* Further extensions to the request are required for the server to fulfill it.
*
* [Read more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/510) |
* [Official Documentation](https://datatracker.ietf.org/doc/html/rfc2774#section-7)
* @type {number}
*/
NotExtended = 510,
/**
* ### 511 Network Authentication Required
*
* The 511 status code indicates that
* the client needs to authenticate to gain network access.
*
* [Read more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/511) |
* [Official Documentation](https://datatracker.ietf.org/doc/html/rfc6585#section-6)
* @type {number}
*/
NetworkAuthenticationRequired = 511
}
export default HttpServerErrorStatusCodes;