0
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-10-30 09:08:00 -04:00

Add jsdoc for std/http/http_status.ts

The website documentation now supports enums
6f4fb0f5a3
This commit is contained in:
Ryan Dahl 2019-11-08 10:57:41 -05:00 committed by Ry Dahl
parent adab69bccc
commit 97ceea49f5

View file

@ -1,70 +1,131 @@
// Copyright 2018-2019 the Deno authors. All rights reserved. MIT license.
/** HTTP status codes */
export enum Status {
Continue = 100, // RFC 7231, 6.2.1
SwitchingProtocols = 101, // RFC 7231, 6.2.2
Processing = 102, // RFC 2518, 10.1
/** RFC 7231, 6.2.1 */
Continue = 100,
/** RFC 7231, 6.2.2 */
SwitchingProtocols = 101,
/** RFC 2518, 10.1 */
Processing = 102,
OK = 200, // RFC 7231, 6.3.1
Created = 201, // RFC 7231, 6.3.2
Accepted = 202, // RFC 7231, 6.3.3
NonAuthoritativeInfo = 203, // RFC 7231, 6.3.4
NoContent = 204, // RFC 7231, 6.3.5
ResetContent = 205, // RFC 7231, 6.3.6
PartialContent = 206, // RFC 7233, 4.1
MultiStatus = 207, // RFC 4918, 11.1
AlreadyReported = 208, // RFC 5842, 7.1
IMUsed = 226, // RFC 3229, 10.4.1
/** RFC 7231, 6.3.1 */
OK = 200,
/** RFC 7231, 6.3.2 */
Created = 201,
/** RFC 7231, 6.3.3 */
Accepted = 202,
/** RFC 7231, 6.3.4 */
NonAuthoritativeInfo = 203,
/** RFC 7231, 6.3.5 */
NoContent = 204,
/** RFC 7231, 6.3.6 */
ResetContent = 205,
/** RFC 7233, 4.1 */
PartialContent = 206,
/** RFC 4918, 11.1 */
MultiStatus = 207,
/** RFC 5842, 7.1 */
AlreadyReported = 208,
/** RFC 3229, 10.4.1 */
IMUsed = 226,
MultipleChoices = 300, // RFC 7231, 6.4.1
MovedPermanently = 301, // RFC 7231, 6.4.2
Found = 302, // RFC 7231, 6.4.3
SeeOther = 303, // RFC 7231, 6.4.4
NotModified = 304, // RFC 7232, 4.1
UseProxy = 305, // RFC 7231, 6.4.5
// _ = 306, // RFC 7231, 6.4.6 (Unused)
TemporaryRedirect = 307, // RFC 7231, 6.4.7
PermanentRedirect = 308, // RFC 7538, 3
/** RFC 7231, 6.4.1 */
MultipleChoices = 300,
/** RFC 7231, 6.4.2 */
MovedPermanently = 301,
/** RFC 7231, 6.4.3 */
Found = 302,
/** RFC 7231, 6.4.4 */
SeeOther = 303,
/** RFC 7232, 4.1 */
NotModified = 304,
/** RFC 7231, 6.4.5 */
UseProxy = 305,
/** RFC 7231, 6.4.7 */
TemporaryRedirect = 307,
/** RFC 7538, 3 */
PermanentRedirect = 308,
BadRequest = 400, // RFC 7231, 6.5.1
Unauthorized = 401, // RFC 7235, 3.1
PaymentRequired = 402, // RFC 7231, 6.5.2
Forbidden = 403, // RFC 7231, 6.5.3
NotFound = 404, // RFC 7231, 6.5.4
MethodNotAllowed = 405, // RFC 7231, 6.5.5
NotAcceptable = 406, // RFC 7231, 6.5.6
ProxyAuthRequired = 407, // RFC 7235, 3.2
RequestTimeout = 408, // RFC 7231, 6.5.7
Conflict = 409, // RFC 7231, 6.5.8
Gone = 410, // RFC 7231, 6.5.9
LengthRequired = 411, // RFC 7231, 6.5.10
PreconditionFailed = 412, // RFC 7232, 4.2
RequestEntityTooLarge = 413, // RFC 7231, 6.5.11
RequestURITooLong = 414, // RFC 7231, 6.5.12
UnsupportedMediaType = 415, // RFC 7231, 6.5.13
RequestedRangeNotSatisfiable = 416, // RFC 7233, 4.4
ExpectationFailed = 417, // RFC 7231, 6.5.14
Teapot = 418, // RFC 7168, 2.3.3
MisdirectedRequest = 421, // RFC 7540, 9.1.2
UnprocessableEntity = 422, // RFC 4918, 11.2
Locked = 423, // RFC 4918, 11.3
FailedDependency = 424, // RFC 4918, 11.4
UpgradeRequired = 426, // RFC 7231, 6.5.15
PreconditionRequired = 428, // RFC 6585, 3
TooManyRequests = 429, // RFC 6585, 4
RequestHeaderFieldsTooLarge = 431, // RFC 6585, 5
UnavailableForLegalReasons = 451, // RFC 7725, 3
/** RFC 7231, 6.5.1 */
BadRequest = 400,
/** RFC 7235, 3.1 */
Unauthorized = 401,
/** RFC 7231, 6.5.2 */
PaymentRequired = 402,
/** RFC 7231, 6.5.3 */
Forbidden = 403,
/** RFC 7231, 6.5.4 */
NotFound = 404,
/** RFC 7231, 6.5.5 */
MethodNotAllowed = 405,
/** RFC 7231, 6.5.6 */
NotAcceptable = 406,
/** RFC 7235, 3.2 */
ProxyAuthRequired = 407,
/** RFC 7231, 6.5.7 */
RequestTimeout = 408,
/** RFC 7231, 6.5.8 */
Conflict = 409,
/** RFC 7231, 6.5.9 */
Gone = 410,
/** RFC 7231, 6.5.10 */
LengthRequired = 411,
/** RFC 7232, 4.2 */
PreconditionFailed = 412,
/** RFC 7231, 6.5.11 */
RequestEntityTooLarge = 413,
/** RFC 7231, 6.5.12 */
RequestURITooLong = 414,
/** RFC 7231, 6.5.13 */
UnsupportedMediaType = 415,
/** RFC 7233, 4.4 */
RequestedRangeNotSatisfiable = 416,
/** RFC 7231, 6.5.14 */
ExpectationFailed = 417,
/** RFC 7168, 2.3.3 */
Teapot = 418,
/** RFC 7540, 9.1.2 */
MisdirectedRequest = 421,
/** RFC 4918, 11.2 */
UnprocessableEntity = 422,
/** RFC 4918, 11.3 */
Locked = 423,
/** RFC 4918, 11.4 */
FailedDependency = 424,
/** RFC 7231, 6.5.15 */
UpgradeRequired = 426,
/** RFC 6585, 3 */
PreconditionRequired = 428,
/** RFC 6585, 4 */
TooManyRequests = 429,
/** RFC 6585, 5 */
RequestHeaderFieldsTooLarge = 431,
/** RFC 7725, 3 */
UnavailableForLegalReasons = 451,
InternalServerError = 500, // RFC 7231, 6.6.1
NotImplemented = 501, // RFC 7231, 6.6.2
BadGateway = 502, // RFC 7231, 6.6.3
ServiceUnavailable = 503, // RFC 7231, 6.6.4
GatewayTimeout = 504, // RFC 7231, 6.6.5
HTTPVersionNotSupported = 505, // RFC 7231, 6.6.6
VariantAlsoNegotiates = 506, // RFC 2295, 8.1
InsufficientStorage = 507, // RFC 4918, 11.5
LoopDetected = 508, // RFC 5842, 7.2
NotExtended = 510, // RFC 2774, 7
NetworkAuthenticationRequired = 511 // RFC 6585, 6
/** RFC 7231, 6.6.1 */
InternalServerError = 500,
/** RFC 7231, 6.6.2 */
NotImplemented = 501,
/** RFC 7231, 6.6.3 */
BadGateway = 502,
/** RFC 7231, 6.6.4 */
ServiceUnavailable = 503,
/** RFC 7231, 6.6.5 */
GatewayTimeout = 504,
/** RFC 7231, 6.6.6 */
HTTPVersionNotSupported = 505,
/** RFC 2295, 8.1 */
VariantAlsoNegotiates = 506,
/** RFC 4918, 11.5 */
InsufficientStorage = 507,
/** RFC 5842, 7.2 */
LoopDetected = 508,
/** RFC 2774, 7 */
NotExtended = 510,
/** RFC 6585, 6 */
NetworkAuthenticationRequired = 511
}
export const STATUS_TEXT = new Map<Status, string>([