deno.land / std@0.224.0 / http / negotiation.ts

negotiation.ts
View Documentation
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
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.// This module is browser compatible.
/** * Contains the functions {@linkcode accepts}, {@linkcode acceptsEncodings}, and * {@linkcode acceptsLanguages} to provide content negotiation capabilities. * * @module */
import { preferredEncodings } from "./_negotiation/encoding.ts";import { preferredLanguages } from "./_negotiation/language.ts";import { preferredMediaTypes } from "./_negotiation/media_type.ts";
/** Loose copy of {@linkcode Request}. */export type Request = { headers: { get(key: string): string | null; };};
/** * Returns an array of media types accepted by the request, in order of * preference. If there are no media types supplied in the request, then any * media type selector will be returned. * * @example * ```ts * import { accepts } from "https://deno.land/std@$STD_VERSION/http/negotiation.ts"; * * const req = new Request("https://example.com/", { * headers: { * "accept": * "text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, *\/*;q=0.8", * }, * }); * * console.log(accepts(req)); * // [ * // "text/html", * // "application/xhtml+xml", * // "image/webp", * // "application/xml", * // "*\/*", * // ] * ``` */export function accepts(request: Request): string[];/** * For a given set of media types, return the best match accepted in the * request. If no media type matches, then the function returns `undefined`. * * @example * ```ts * import { accepts } from "https://deno.land/std@$STD_VERSION/http/negotiation.ts"; * * const req = new Request("https://example.com/", { * headers: { * "accept": * "text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, *\/*;q=0.8", * }, * }); * * accepts(req, "text/html", "image/webp"); // "text/html"; * ``` */export function accepts( request: Request, ...types: string[]): string | undefined;export function accepts( request: Request, ...types: string[]): string | string[] | undefined { const accept = request.headers.get("accept"); return types.length ? accept ? preferredMediaTypes(accept, types)[0] : types[0] : accept ? preferredMediaTypes(accept) : ["*/*"];}
/** * Returns an array of content encodings accepted by the request, in order of * preference. If there are no encoding supplied in the request, then `["*"]` * is returned, implying any encoding is accepted. * * @example * ```ts * import { acceptsEncodings } from "https://deno.land/std@$STD_VERSION/http/negotiation.ts"; * * const req = new Request("https://example.com/", { * headers: { "accept-encoding": "deflate, gzip;q=1.0, *;q=0.5" }, * }); * * acceptsEncodings(req); // ["deflate", "gzip", "*"] * ``` */export function acceptsEncodings(request: Request): string[];/** * For a given set of content encodings, return the best match accepted in the * request. If no content encodings match, then the function returns * `undefined`. * * **NOTE:** You should always supply `identity` as one of the encodings * to ensure that there is a match when the `Accept-Encoding` header is part * of the request. * * @example * ```ts * import { acceptsEncodings } from "https://deno.land/std@$STD_VERSION/http/negotiation.ts"; * * const req = new Request("https://example.com/", { * headers: { "accept-encoding": "deflate, gzip;q=1.0, *;q=0.5" }, * }); * * acceptsEncodings(req, "gzip", "identity"); // "gzip" * ``` */export function acceptsEncodings( request: Request, ...encodings: string[]): string | undefined;export function acceptsEncodings( request: Request, ...encodings: string[]): string | string[] | undefined { const acceptEncoding = request.headers.get("accept-encoding"); return encodings.length ? acceptEncoding ? preferredEncodings(acceptEncoding, encodings)[0] : encodings[0] : acceptEncoding ? preferredEncodings(acceptEncoding) : ["*"];}
/** * Returns an array of languages accepted by the request, in order of * preference. If there are no languages supplied in the request, then `["*"]` * is returned, imply any language is accepted. * * @example * ```ts * import { acceptsLanguages } from "https://deno.land/std@$STD_VERSION/http/negotiation.ts"; * * const req = new Request("https://example.com/", { * headers: { * "accept-language": "fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5", * }, * }); * * acceptsLanguages(req); // ["fr-CH", "fr", "en", "de", "*"] * ``` */export function acceptsLanguages(request: Request): string[];/** * For a given set of languages, return the best match accepted in the request. * If no languages match, then the function returns `undefined`. * * @example * ```ts * import { acceptsLanguages } from "https://deno.land/std@$STD_VERSION/http/negotiation.ts"; * * const req = new Request("https://example.com/", { * headers: { * "accept-language": "fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5", * }, * }); * * acceptsLanguages(req, "en-gb", "en-us", "en"); // "en" * ``` */export function acceptsLanguages( request: Request, ...langs: string[]): string | undefined;export function acceptsLanguages( request: Request, ...langs: string[]): string | string[] | undefined { const acceptLanguage = request.headers.get("accept-language"); return langs.length ? acceptLanguage ? preferredLanguages(acceptLanguage, langs)[0] : langs[0] : acceptLanguage ? preferredLanguages(acceptLanguage) : ["*"];}
std

Version Info

Tagged at
6 months ago