Mercurial > hg > nginx-site
comparison xml/en/docs/njs/reference.xml @ 2777:bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Thu, 14 Oct 2021 18:53:16 +0100 |
parents | 9ce9239c6b7b |
children | 87713cb4be56 |
comparison
equal
deleted
inserted
replaced
2776:bbe072c9b278 | 2777:bc79ab31073a |
---|---|
7 <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd"> | 7 <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd"> |
8 | 8 |
9 <article name="Reference" | 9 <article name="Reference" |
10 link="/en/docs/njs/reference.html" | 10 link="/en/docs/njs/reference.html" |
11 lang="en" | 11 lang="en" |
12 rev="76"> | 12 rev="77"> |
13 | 13 |
14 <section id="summary"> | 14 <section id="summary"> |
15 | 15 |
16 <para> | 16 <para> |
17 <link doc="index.xml">njs</link> provides objects, methods and properties | 17 <link doc="index.xml">njs</link> provides objects, methods and properties |
369 <tag-name id="r_send_header"><literal>r.sendHeader()</literal></tag-name> | 369 <tag-name id="r_send_header"><literal>r.sendHeader()</literal></tag-name> |
370 <tag-desc> | 370 <tag-desc> |
371 sends the HTTP headers to the client | 371 sends the HTTP headers to the client |
372 </tag-desc> | 372 </tag-desc> |
373 | 373 |
374 <tag-name id="r_set_return_value"><literal>r.setReturnValue()</literal></tag-name> | |
375 <tag-desc> | |
376 sets the return value of the | |
377 <link doc="../http/ngx_http_js_module.xml" id="js_set"/> handler | |
378 (<link doc="changes.xml" id="njs0.7.0">0.7.0</link>). | |
379 Unlike an ordinary return statement, | |
380 this method should be used when the handler is JS async function. | |
381 For example: | |
382 <example> | |
383 async function js_set(r) { | |
384 const digest = await crypto.subtle.digest('SHA-256', r.headersIn.host); | |
385 r.setReturnValue(digest); | |
386 } | |
387 </example> | |
388 </tag-desc> | |
389 | |
374 <tag-name id="r_status"><literal>r.status</literal></tag-name> | 390 <tag-name id="r_status"><literal>r.status</literal></tag-name> |
375 <tag-desc> | 391 <tag-desc> |
376 status, writable | 392 status, writable |
377 </tag-desc> | 393 </tag-desc> |
378 | 394 |
687 session status code, an alias to the | 703 session status code, an alias to the |
688 <link doc="../stream/ngx_stream_core_module.xml" id="var_status"><literal>$status</literal></link> | 704 <link doc="../stream/ngx_stream_core_module.xml" id="var_status"><literal>$status</literal></link> |
689 variable, | 705 variable, |
690 read only | 706 read only |
691 (since <link doc="changes.xml" id="njs0.5.2">0.5.2</link>) | 707 (since <link doc="changes.xml" id="njs0.5.2">0.5.2</link>) |
708 </tag-desc> | |
709 | |
710 <tag-name id="s_set_return_value"><literal>s.setReturnValue()</literal></tag-name> | |
711 <tag-desc> | |
712 sets the return value of the | |
713 <link doc="../stream/ngx_stream_js_module.xml" id="js_set"/> handler | |
714 (<link doc="changes.xml" id="njs0.7.0">0.7.0</link>). | |
715 Unlike an ordinary return statement, | |
716 this method should be used when the handler is JS async function. | |
717 For example: | |
718 <example> | |
719 async function js_set(r) { | |
720 const digest = await crypto.subtle.digest('SHA-256', r.headersIn.host); | |
721 r.setReturnValue(digest); | |
722 } | |
723 </example> | |
692 </tag-desc> | 724 </tag-desc> |
693 | 725 |
694 <tag-name id="s_variables"><literal>s.variables{}</literal></tag-name> | 726 <tag-name id="s_variables"><literal>s.variables{}</literal></tag-name> |
695 <tag-desc> | 727 <tag-desc> |
696 nginx variables object, writable | 728 nginx variables object, writable |