Mercurial > hg > nginx-site

comparison xml/en/docs/stream/ngx_stream_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 fd8ec06ceafa
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_stream_js_module" 9 <module name="Module ngx_stream_js_module"
10 link="/en/docs/stream/ngx_stream_js_module.html" 10 link="/en/docs/stream/ngx_stream_js_module.html"
11 lang="en" 11 lang="en"
12 rev="30"> 12 rev="31">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_stream_js_module</literal> module is used to implement 17 The <literal>ngx_stream_js_module</literal> module is used to implement
143 </para> 143 </para>
144 144
145 </directive> 145 </directive>
146 146
147 147
148 <directive name="js_fetch_buffer_size">
149 <syntax><value>size</value></syntax>
150 <default>16k</default>
151 <context>stream</context>
152 <context>server</context>
153 <appeared-in>0.7.4</appeared-in>
154
155 <para>
156 Sets the <value>size</value> of the buffer used for reading and writing
157 with <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
158 </para>
159
160 </directive>
161
162
148 <directive name="js_fetch_ciphers"> 163 <directive name="js_fetch_ciphers">
149 <syntax><value>ciphers</value></syntax> 164 <syntax><value>ciphers</value></syntax>
150 <default>HIGH:!aNULL:!MD5</default> 165 <default>HIGH:!aNULL:!MD5</default>
151 <context>stream</context> 166 <context>stream</context>
152 <context>server</context> 167 <context>server</context>
159 </para> 174 </para>
160 175
161 <para> 176 <para>
162 The full list can be viewed using the 177 The full list can be viewed using the
163 “<command>openssl ciphers</command>” command. 178 “<command>openssl ciphers</command>” command.
179 </para>
180
181 </directive>
182
183
184 <directive name="js_fetch_max_response_buffer_size">
185 <syntax><value>size</value></syntax>
186 <default>1m</default>
187 <context>stream</context>
188 <context>server</context>
189 <appeared-in>0.7.4</appeared-in>
190
191 <para>
192 Sets the maximum <value>size</value> of the response received
193 with <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
164 </para> 194 </para>
165 195
166 </directive> 196 </directive>
167 197
168 198
183 </para> 213 </para>
184 214
185 </directive> 215 </directive>
186 216
187 217
218 <directive name="js_fetch_timeout">
219 <syntax><value>time</value></syntax>
220 <default>60s</default>
221 <context>stream</context>
222 <context>server</context>
223 <appeared-in>0.7.4</appeared-in>
224
225 <para>
226 Defines a timeout for reading and writing
227 for <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
228 The timeout is set only between two successive read/write operations,
229 not for the whole response.
230 If no data is transmitted within this time, the connection is closed.
231 </para>
232
233 </directive>
234
235
188 <directive name="js_fetch_trusted_certificate"> 236 <directive name="js_fetch_trusted_certificate">
189 <syntax><value>file</value></syntax> 237 <syntax><value>file</value></syntax>
190 <default/> 238 <default/>
191 <context>stream</context> 239 <context>stream</context>
192 <context>server</context> 240 <context>server</context>
195 <para> 243 <para>
196 Specifies a <value>file</value> with trusted CA certificates in the PEM format 244 Specifies a <value>file</value> with trusted CA certificates in the PEM format
197 used to 245 used to
198 <link doc="../njs/reference.xml" id="fetch_verify">verify</link> 246 <link doc="../njs/reference.xml" id="fetch_verify">verify</link>
199 the HTTPS certificate 247 the HTTPS certificate
248 with <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
249 </para>
250
251 </directive>
252
253
254 <directive name="js_fetch_verify">
255 <syntax><literal>on</literal> | <literal>off</literal></syntax>
256 <default>on</default>
257 <context>stream</context>
258 <context>server</context>
259 <appeared-in>0.7.4</appeared-in>
260
261 <para>
262 Enables or disables verification of the HTTPS server certificate
200 with <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>. 263 with <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
201 </para> 264 </para>
202 265
203 </directive> 266 </directive>
204 267