Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_js_module.xml @ 2845:a3aee2697d4e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented directives for Fetch API in njs.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 05 May 2022 18:31:47 +0100
parents 652356b39f0f
children 986e1f930e3b
comparison
equal deleted inserted replaced
2844:eb11724745e3 2845:a3aee2697d4e
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_http_js_module" 9 <module name="Module ngx_http_js_module"
10 link="/en/docs/http/ngx_http_js_module.html" 10 link="/en/docs/http/ngx_http_js_module.html"
11 lang="en" 11 lang="en"
12 rev="34"> 12 rev="35">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_http_js_module</literal> module is used to implement 17 The <literal>ngx_http_js_module</literal> module is used to implement
242 </para> 242 </para>
243 243
244 </directive> 244 </directive>
245 245
246 246
247 <directive name="js_fetch_buffer_size">
248 <syntax><value>size</value></syntax>
249 <default>16k</default>
250 <context>http</context>
251 <context>server</context>
252 <context>location</context>
253 <appeared-in>0.7.4</appeared-in>
254
255 <para>
256 Sets the <value>size</value> of the buffer used for reading and writing
257 with <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
258 </para>
259
260 </directive>
261
262
247 <directive name="js_fetch_ciphers"> 263 <directive name="js_fetch_ciphers">
248 <syntax><value>ciphers</value></syntax> 264 <syntax><value>ciphers</value></syntax>
249 <default>HIGH:!aNULL:!MD5</default> 265 <default>HIGH:!aNULL:!MD5</default>
250 <context>http</context> 266 <context>http</context>
251 <context>server</context> 267 <context>server</context>
260 </para> 276 </para>
261 277
262 <para> 278 <para>
263 The full list can be viewed using the 279 The full list can be viewed using the
264 “<command>openssl ciphers</command>” command. 280 “<command>openssl ciphers</command>” command.
281 </para>
282
283 </directive>
284
285
286 <directive name="js_fetch_max_response_buffer_size">
287 <syntax><value>size</value></syntax>
288 <default>1m</default>
289 <context>http</context>
290 <context>server</context>
291 <context>location</context>
292 <appeared-in>0.7.4</appeared-in>
293
294 <para>
295 Sets the maximum <value>size</value> of the response received
296 with <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
265 </para> 297 </para>
266 298
267 </directive> 299 </directive>
268 300
269 301
285 </para> 317 </para>
286 318
287 </directive> 319 </directive>
288 320
289 321
322 <directive name="js_fetch_timeout">
323 <syntax><value>time</value></syntax>
324 <default>60s</default>
325 <context>http</context>
326 <context>server</context>
327 <context>location</context>
328 <appeared-in>0.7.4</appeared-in>
329
330 <para>
331 Defines a timeout for reading and writing
332 for <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
333 The timeout is set only between two successive read/write operations,
334 not for the whole response.
335 If no data is transmitted within this time, the connection is closed.
336 </para>
337
338 </directive>
339
340
290 <directive name="js_fetch_trusted_certificate"> 341 <directive name="js_fetch_trusted_certificate">
291 <syntax><value>file</value></syntax> 342 <syntax><value>file</value></syntax>
292 <default/> 343 <default/>
293 <context>http</context> 344 <context>http</context>
294 <context>server</context> 345 <context>server</context>
298 <para> 349 <para>
299 Specifies a <value>file</value> with trusted CA certificates in the PEM format 350 Specifies a <value>file</value> with trusted CA certificates in the PEM format
300 used to 351 used to
301 <link doc="../njs/reference.xml" id="fetch_verify">verify</link> 352 <link doc="../njs/reference.xml" id="fetch_verify">verify</link>
302 the HTTPS certificate 353 the HTTPS certificate
354 with <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
355 </para>
356
357 </directive>
358
359
360 <directive name="js_fetch_verify">
361 <syntax><literal>on</literal> | <literal>off</literal></syntax>
362 <default>on</default>
363 <context>http</context>
364 <context>server</context>
365 <context>location</context>
366 <appeared-in>0.7.4</appeared-in>
367
368 <para>
369 Enables or disables verification of the HTTPS server certificate
303 with <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>. 370 with <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
304 </para> 371 </para>
305 372
306 </directive> 373 </directive>
307 374