Mercurial > hg > nginx-site

comparison xml/en/docs/njs/reference.xml @ 2353:21f3a93fbe97

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
njs-0.3.0
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 26 Mar 2019 17:19:37 +0300
parents 5e17930672f5
children ea6964391d52
comparison
equal deleted inserted replaced
2352:1101e24c6d14 2353:21f3a93fbe97
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="25"> 12 rev="26">
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
31 <link doc="../http/ngx_http_js_module.xml">ngx_http_js_module</link> module. 31 <link doc="../http/ngx_http_js_module.xml">ngx_http_js_module</link> module.
32 All string properties of the object are <link id="string">byte strings</link>. 32 All string properties of the object are <link id="string">byte strings</link>.
33 33
34 <list type="tag"> 34 <list type="tag">
35 35
36 <tag-name><literal>r.args{}</literal></tag-name> 36 <tag-name id="r_args"><literal>r.args{}</literal></tag-name>
37 <tag-desc> 37 <tag-desc>
38 request arguments object, read-only 38 request arguments object, read-only
39 </tag-desc> 39 </tag-desc>
40 40
41 <tag-name><literal>r.error(<value>string</value>)</literal></tag-name> 41 <tag-name><literal>r.error(<value>string</value>)</literal></tag-name>
47 <tag-name><literal>r.finish()</literal></tag-name> 47 <tag-name><literal>r.finish()</literal></tag-name>
48 <tag-desc> 48 <tag-desc>
49 finishes sending a response to the client 49 finishes sending a response to the client
50 </tag-desc> 50 </tag-desc>
51 51
52 <tag-name><literal>r.headersIn{}</literal></tag-name> 52 <tag-name id="r_headers_in"><literal>r.headersIn{}</literal></tag-name>
53 <tag-desc> 53 <tag-desc>
54 incoming headers object, read-only. 54 incoming headers object, read-only.
55 <para> 55 <para>
56 For example, the <literal>Foo</literal> header 56 For example, the <literal>Foo</literal> header
57 can be accessed with the syntax <literal>headersIn.foo</literal> 57 can be accessed with the syntax <literal>headersIn.foo</literal>
111 <link doc="../http/ngx_http_core_module.xml" id="client_max_body_size"/>, 111 <link doc="../http/ngx_http_core_module.xml" id="client_max_body_size"/>,
112 and a sufficient buffer size should be set using 112 and a sufficient buffer size should be set using
113 <link doc="../http/ngx_http_core_module.xml" id="client_body_buffer_size"/>. 113 <link doc="../http/ngx_http_core_module.xml" id="client_body_buffer_size"/>.
114 </tag-desc> 114 </tag-desc>
115 115
116 <tag-name><literal>r.responseBody</literal></tag-name> 116 <tag-name id="r_response_body"><literal>r.responseBody</literal></tag-name>
117 <tag-desc> 117 <tag-desc>
118 holds the <link id="subrequest">subrequest</link> response body, read-only. 118 holds the <link id="subrequest">subrequest</link> response body, read-only.
119 The size of <literal>r.responseBody</literal> is limited by the 119 The size of <literal>r.responseBody</literal> is limited by the
120 <link doc="../http/ngx_http_core_module.xml" id="subrequest_output_buffer_size"/> 120 <link doc="../http/ngx_http_core_module.xml" id="subrequest_output_buffer_size"/>
121 directive. 121 directive.