deno.land / std@0.166.0 / http / http_status.ts

http_status.ts
نووسراو ببینە
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.// This module is browser compatible.
/** * Contains the enum {@linkcode Status} which enumerates standard HTTP status * codes and provides several type guards for handling status codes with type * safety. * * ### Examples * * ```ts * import { * Status, * STATUS_TEXT, * } from "https://deno.land/std@$STD_VERSION/http/http_status.ts"; * * console.log(Status.NotFound); //=> 404 * console.log(STATUS_TEXT[Status.NotFound]); //=> "Not Found" * ``` * * ```ts * import { isErrorStatus } from "https://deno.land/std@$STD_VERSION/http/http_status.ts"; * * const res = await fetch("https://example.com/"); * * if (isErrorStatus(res.status)) { * // error handling here... * } * ``` * * @module */
/** Standard HTTP status codes. */export enum Status { /** RFC 7231, 6.2.1 */ Continue = 100, /** RFC 7231, 6.2.2 */ SwitchingProtocols = 101, /** RFC 2518, 10.1 */ Processing = 102, /** RFC 8297 **/ EarlyHints = 103,
/** 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,
/** 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,
/** 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 8470, 5.2 */ TooEarly = 425, /** 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,
/** 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,}
/** A record of all the status codes text. */export const STATUS_TEXT: Readonly<Record<Status, string>> = { [Status.Accepted]: "Accepted", [Status.AlreadyReported]: "Already Reported", [Status.BadGateway]: "Bad Gateway", [Status.BadRequest]: "Bad Request", [Status.Conflict]: "Conflict", [Status.Continue]: "Continue", [Status.Created]: "Created", [Status.EarlyHints]: "Early Hints", [Status.ExpectationFailed]: "Expectation Failed", [Status.FailedDependency]: "Failed Dependency", [Status.Forbidden]: "Forbidden", [Status.Found]: "Found", [Status.GatewayTimeout]: "Gateway Timeout", [Status.Gone]: "Gone", [Status.HTTPVersionNotSupported]: "HTTP Version Not Supported", [Status.IMUsed]: "IM Used", [Status.InsufficientStorage]: "Insufficient Storage", [Status.InternalServerError]: "Internal Server Error", [Status.LengthRequired]: "Length Required", [Status.Locked]: "Locked", [Status.LoopDetected]: "Loop Detected", [Status.MethodNotAllowed]: "Method Not Allowed", [Status.MisdirectedRequest]: "Misdirected Request", [Status.MovedPermanently]: "Moved Permanently", [Status.MultiStatus]: "Multi Status", [Status.MultipleChoices]: "Multiple Choices", [Status.NetworkAuthenticationRequired]: "Network Authentication Required", [Status.NoContent]: "No Content", [Status.NonAuthoritativeInfo]: "Non Authoritative Info", [Status.NotAcceptable]: "Not Acceptable", [Status.NotExtended]: "Not Extended", [Status.NotFound]: "Not Found", [Status.NotImplemented]: "Not Implemented", [Status.NotModified]: "Not Modified", [Status.OK]: "OK", [Status.PartialContent]: "Partial Content", [Status.PaymentRequired]: "Payment Required", [Status.PermanentRedirect]: "Permanent Redirect", [Status.PreconditionFailed]: "Precondition Failed", [Status.PreconditionRequired]: "Precondition Required", [Status.Processing]: "Processing", [Status.ProxyAuthRequired]: "Proxy Auth Required", [Status.RequestEntityTooLarge]: "Request Entity Too Large", [Status.RequestHeaderFieldsTooLarge]: "Request Header Fields Too Large", [Status.RequestTimeout]: "Request Timeout", [Status.RequestURITooLong]: "Request URI Too Long", [Status.RequestedRangeNotSatisfiable]: "Requested Range Not Satisfiable", [Status.ResetContent]: "Reset Content", [Status.SeeOther]: "See Other", [Status.ServiceUnavailable]: "Service Unavailable", [Status.SwitchingProtocols]: "Switching Protocols", [Status.Teapot]: "I'm a teapot", [Status.TemporaryRedirect]: "Temporary Redirect", [Status.TooEarly]: "Too Early", [Status.TooManyRequests]: "Too Many Requests", [Status.Unauthorized]: "Unauthorized", [Status.UnavailableForLegalReasons]: "Unavailable For Legal Reasons", [Status.UnprocessableEntity]: "Unprocessable Entity", [Status.UnsupportedMediaType]: "Unsupported Media Type", [Status.UpgradeRequired]: "Upgrade Required", [Status.UseProxy]: "Use Proxy", [Status.VariantAlsoNegotiates]: "Variant Also Negotiates",};
/** An HTTP status that is a informational (1XX). */export type InformationalStatus = | Status.Continue | Status.SwitchingProtocols | Status.Processing | Status.EarlyHints;
/** An HTTP status that is a success (2XX). */export type SuccessfulStatus = | Status.OK | Status.Created | Status.Accepted | Status.NonAuthoritativeInfo | Status.NoContent | Status.ResetContent | Status.PartialContent | Status.MultiStatus | Status.AlreadyReported | Status.IMUsed;
/** An HTTP status that is a redirect (3XX). */export type RedirectStatus = | Status.MultipleChoices // 300 | Status.MovedPermanently // 301 | Status.Found // 302 | Status.SeeOther // 303 | Status.UseProxy // 305 - DEPRECATED | Status.TemporaryRedirect // 307 | Status.PermanentRedirect; // 308
/** An HTTP status that is a client error (4XX). */export type ClientErrorStatus = | Status.BadRequest | Status.Unauthorized | Status.PaymentRequired | Status.Forbidden | Status.NotFound | Status.MethodNotAllowed | Status.NotAcceptable | Status.ProxyAuthRequired | Status.RequestTimeout | Status.Conflict | Status.Gone | Status.LengthRequired | Status.PreconditionFailed | Status.RequestEntityTooLarge | Status.RequestURITooLong | Status.UnsupportedMediaType | Status.RequestedRangeNotSatisfiable | Status.ExpectationFailed | Status.Teapot | Status.MisdirectedRequest | Status.UnprocessableEntity | Status.Locked | Status.FailedDependency | Status.UpgradeRequired | Status.PreconditionRequired | Status.TooManyRequests | Status.RequestHeaderFieldsTooLarge | Status.UnavailableForLegalReasons;
/** An HTTP status that is a server error (5XX). */export type ServerErrorStatus = | Status.InternalServerError | Status.NotImplemented | Status.BadGateway | Status.ServiceUnavailable | Status.GatewayTimeout | Status.HTTPVersionNotSupported | Status.VariantAlsoNegotiates | Status.InsufficientStorage | Status.LoopDetected | Status.NotExtended | Status.NetworkAuthenticationRequired;
/** An HTTP status that is an error (4XX and 5XX). */export type ErrorStatus = ClientErrorStatus | ServerErrorStatus;
/** A type guard that determines if the status code is informational. */export function isInformationalStatus( status: Status,): status is InformationalStatus { return status >= 100 && status < 200;}
/** A type guard that determines if the status code is successful. */export function isSuccessfulStatus(status: Status): status is SuccessfulStatus { return status >= 200 && status < 300;}
/** A type guard that determines if the status code is a redirection. */export function isRedirectStatus(status: Status): status is RedirectStatus { return status >= 300 && status < 400;}
/** A type guard that determines if the status code is a client error. */export function isClientErrorStatus( status: Status,): status is ClientErrorStatus { return status >= 400 && status < 500;}
/** A type guard that determines if the status code is a server error. */export function isServerErrorStatus( status: Status,): status is ServerErrorStatus { return status >= 500 && status < 600;}
/** A type guard that determines if the status code is an error. */export function isErrorStatus(status: Status): status is ErrorStatus { return status >= 400 && status < 600;}
std
Deno standard library
GitHub Repositorydenoland/deno_std
GitHub Stars
2457

Version Info

Tagged at
2 months ago