annotate xml/en/docs/njs/njs_api.xml @ 2176:95b406f1f347

Added njs JSON API.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 05 Jun 2018 18:23:19 +0300
parents cd4889fdcfa4
children 79297494d291
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
2
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
3 <!--
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
4 Copyright (C) Nginx, Inc.
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
5 -->
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
6
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
7 <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
8
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
9 <article name="njs API"
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
10 link="/en/docs/njs/njs_api.html"
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
11 lang="en"
2176
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
12 rev="2">
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
13
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
14 <section id="summary">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
15
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
16 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
17 <link doc="../njs_about.xml">njs</link> provides objects, methods and properties
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
18 for extending nginx functionality.
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
19 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
20
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
21 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
22
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
23
2176
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
24 <section id="core" name="Core">
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
25
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
26
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
27 <section id="core_json" name="JSON">
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
28
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
29 <para>
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
30 The <literal>JSON</literal> object (ES 5.1) provides functions
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
31 to convert njs values to and from JSON format.
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
32 <list type="tag">
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
33
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
34 <tag-name><literal>JSON.parse(<value>string</value>[,
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
35 <value>reviver</value>])</literal></tag-name>
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
36 <tag-desc>
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
37 Converts a <literal>string</literal> that represents JSON data
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
38 into an njs object (<literal>{...}</literal>) or
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
39 array (<literal>[...]</literal>).
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
40 The optional <literal>reviver</literal> parameter is a function (key, value)
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
41 that will be called for each (key,value) pair and can transform the value.
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
42 </tag-desc>
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
43
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
44 <tag-name><literal>JSON.stringify(<value>value</value>[,
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
45 <value>replacer</value>] [, <value>space</value>])</literal></tag-name>
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
46 <tag-desc>
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
47 Converts an njs object back to JSON.
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
48 The obligatory <literal>value</literal> parameter is generally a JSON
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
49 <literal>object</literal> or <literal>array</literal> that will be converted.
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
50 If the value has a <literal>toJSON()</literal> method,
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
51 it defines how the object will be serialized.
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
52 The optional <literal>replacer</literal> parameter is
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
53 a <literal>function</literal> or <literal>array</literal>
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
54 that transforms results.
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
55 The optional <literal>space</literal> parameter is
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
56 a <literal>string</literal> or <literal>number</literal>.
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
57 If it is a <literal>number</literal>,
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
58 it indicates the number of white spaces placed before a result
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
59 (no more than 10).
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
60 If it is a <literal>string</literal>,
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
61 it is used as a white space (or first 10 characters of it).
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
62 If omitted or is <literal>null</literal>, no white space is used.
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
63 </tag-desc>
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
64 </list>
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
65 </para>
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
66
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
67 <para>
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
68 <example>
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
69 >> var json = JSON.parse('{"a":1, "b":true}')
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
70 >> json.a
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
71 1
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
72
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
73 >> JSON.stringify(json)
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
74 {"a":1,"b":true}
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
75
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
76 >> JSON.stringify(json, undefined, 1)
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
77 {
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
78 "a": 1,
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
79 "b": true
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
80 }
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
81
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
82 >> JSON.stringify({ x: [10, undefined, function(){}] })
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
83 {"x":[10,null,null]}
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
84
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
85 >> JSON.stringify({"a":1, "toJSON": function() {return "xxx"}})
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
86 "xxx"
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
87
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
88 # Example with function replacer
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
89
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
90 >> function replacer(key, value) {return (typeof value === 'string') ? undefined : value}
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
91 >>JSON.stringify({a:1, b:"b", c:true}, replacer)
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
92 {"a":1,"c":true}
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
93 </example>
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
94 </para>
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
95
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
96 </section>
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
97
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
98 </section>
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
99
95b406f1f347 Added njs JSON API.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
100
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
101 <section id="http" name="HTTP">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
102
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
103 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
104 The <literal>HTTP</literal> objects are available only in the
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
105 <link doc="../http/ngx_http_js_module.xml">ngx_http_js_module</link> module.
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
106 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
107
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
108
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
109 <section id="http_request" name="Request">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
110
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
111 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
112 <list type="tag">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
113
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
114 <tag-name><literal>req.uri</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
115 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
116 current URI in a request, read-only
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
117 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
118
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
119 <tag-name><literal>req.method</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
120 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
121 request method, read-only
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
122 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
123
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
124 <tag-name><literal>req.httpVersion</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
125 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
126 HTTP version, read-only
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
127 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
128
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
129 <tag-name><literal>req.remoteAddress</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
130 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
131 client address, read-only
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
132 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
133
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
134 <tag-name><literal>req.headers{}</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
135 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
136 request headers object, read-only.
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
137 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
138 For example, the <literal>Header-Name</literal> header
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
139 can be accessed with the syntax <literal>headers['Header-Name']</literal>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
140 or <literal>headers.Header_name</literal>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
141 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
142 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
143
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
144 <tag-name><literal>req.args{}</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
145 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
146 request arguments object, read-only
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
147 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
148
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
149 <tag-name><literal>request.variables{}</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
150 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
151 nginx variables object, read-only
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
152 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
153
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
154 <tag-name><literal>req.response</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
155 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
156 the <link id="http_response">response</link> object (0.2.0), read-only
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
157 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
158
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
159 <tag-name><literal>req.log(<value>string</value>)</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
160 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
161 writes a <literal>string</literal> to the error log
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
162 on the <literal>info</literal> level of logging
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
163 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
164
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
165 <tag-name><literal>req.warn(<value>string</value>)</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
166 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
167 writes a <literal>string</literal> to the error log
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
168 on the <literal>warning</literal> level of logging (0.2.0)
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
169 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
170
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
171 <tag-name><literal>req.error(<value>string</value>)</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
172 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
173 writes a <literal>string</literal> to the error log
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
174 on the <literal>error</literal> level of logging (0.2.0)
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
175 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
176
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
177 <tag-name id="subrequest"><literal>req.subrequest(<value>uri</value>[,
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
178 <value>options</value>[, <value>callback</value>]])</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
179 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
180 creates a subrequest with the given <literal>uri</literal> and
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
181 <literal>options</literal>, and installs
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
182 an optional completion <literal>callback</literal> (0.2.0).
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
183
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
184 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
185 If <literal>options</literal> is a string, then it
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
186 holds the subrequest arguments string.
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
187 Otherwise, <literal>options</literal> is expected to be
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
188 an object with the following keys:
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
189
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
190 <list type="tag">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
191 <tag-name><literal>args</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
192 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
193 arguments string
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
194 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
195
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
196 <tag-name><literal>body</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
197 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
198 request body
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
199 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
200
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
201 <tag-name><literal>method</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
202 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
203 HTTP method
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
204 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
205 </list>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
206 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
207
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
208 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
209 The completion <literal>callback</literal>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
210 receives a <link id="http_reply_object">reply</link> object.
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
211 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
212 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
213
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
214 </list>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
215 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
216
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
217 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
218
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
219
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
220 <section id="http_response" name="Response">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
221
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
222 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
223 <list type="tag">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
224
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
225 <tag-name><literal>res.status</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
226 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
227 response status, writable
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
228 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
229
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
230 <tag-name><literal>res.headers{}</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
231 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
232 response headers object
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
233 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
234
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
235 <tag-name><literal>res.contentType</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
236 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
237 the response <header>Content-Type</header> header field value, writable
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
238 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
239
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
240 <tag-name><literal>res.contentLength</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
241 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
242 the response <header>Content-Length</header> header field value, writable
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
243 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
244
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
245 <tag-name><literal>res.sendHeader()</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
246 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
247 sends the HTTP header to the client
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
248 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
249
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
250 <tag-name><literal>res.send(<value>string</value>)</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
251 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
252 sends a part of the response body to the client
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
253 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
254
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
255 <tag-name><literal>res.finish()</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
256 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
257 finishes sending a response to the client
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
258 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
259
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
260 <tag-name><literal>res.return(status[, string])</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
261 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
262 sends
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
263 the entire response with the specified <literal>status</literal> to the client
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
264 (0.2.0)
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
265 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
266 It is possible to specify either a redirect URL
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
267 (for codes 301, 302, 303, 307, and 308)
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
268 or the response body text (for other codes) as the second argument
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
269 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
270 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
271
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
272 </list>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
273 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
274
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
275 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
276
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
277
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
278 <section id="http_reply" name="Reply">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
279
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
280 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
281 <list type="tag">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
282
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
283 <tag-name><literal>reply.uri</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
284 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
285 current URI in a reply, read-only
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
286 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
287
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
288 <tag-name><literal>reply.method</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
289 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
290 reply method, read-only
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
291 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
292
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
293 <tag-name><literal>reply.status</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
294 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
295 reply status, writable
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
296 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
297
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
298 <tag-name><literal>reply.contentType</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
299 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
300 the response <header>Content-Type</header> header field value, writable
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
301 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
302
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
303 <tag-name><literal>reply.contentLength</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
304 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
305 the response <header>Content-Length</header> header field value, writable
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
306 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
307
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
308 <tag-name><literal>reply.headers{}</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
309 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
310 reply headers object, read-only
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
311 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
312
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
313 </list>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
314 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
315
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
316 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
317 Additionally, the <literal>reply</literal> object has
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
318 the following properties:
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
319
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
320 <list type="tag">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
321
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
322 <tag-name><literal>reply.body</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
323 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
324 holds the subrequest response body
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
325 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
326
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
327 <tag-name><literal>reply.parent</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
328 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
329 references the parent request object
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
330 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
331
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
332 </list>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
333 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
334
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
335 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
336
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
337 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
338
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
339
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
340 <section id="stream" name="Stream">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
341
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
342 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
343 The <literal>stream</literal> objects are available only in the
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
344 <link doc="../stream/ngx_stream_js_module.xml">ngx_stream_js_module</link>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
345 module.
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
346 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
347
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
348
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
349 <section id="stream_session" name="Session">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
350
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
351 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
352 <list type="tag">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
353
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
354 <tag-name><literal>s.remoteAddress</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
355 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
356 client address, read-only
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
357 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
358
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
359 <tag-name><literal>s.eof</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
360 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
361 a boolean read-only property, true if the current buffer is the last buffer
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
362 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
363
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
364 <tag-name><literal>s.fromUpstream</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
365 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
366 a boolean read-only property,
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
367 true if the current buffer is from the upstream server to the client
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
368 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
369
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
370 <tag-name><literal>s.buffer</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
371 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
372 the current buffer, writable
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
373 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
374
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
375 <tag-name><literal>s.variables{}</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
376 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
377 nginx variables object, read-only
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
378 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
379
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
380 <tag-name><literal>s.OK</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
381 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
382 the <literal>OK</literal> return code
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
383 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
384
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
385 <tag-name><literal>s.DECLINED</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
386 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
387 the <literal>DECLINED</literal> return code
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
388 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
389
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
390 <tag-name><literal>s.AGAIN</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
391 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
392 the <literal>AGAIN</literal> return code
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
393 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
394
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
395 <tag-name><literal>s.ERROR</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
396 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
397 the <literal>ERROR</literal> return code
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
398 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
399
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
400 <tag-name><literal>s.ABORT</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
401 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
402 the <literal>ABORT</literal> return code
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
403 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
404
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
405 <tag-name><literal>s.log(<value>string</value>)</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
406 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
407 writes a sent <value>string</value> to the error log
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
408 on the <literal>info</literal> level of logging
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
409 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
410
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
411 <tag-name><literal>s.warn(<value>string</value>)</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
412 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
413 writes a sent <literal>string</literal> to the error log
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
414 on the <literal>warning</literal> level of logging (0.2.0)
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
415 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
416
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
417 <tag-name><literal>s.error(<value>string</value>)</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
418 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
419 writes a sent <literal>string</literal> to the error log
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
420 on the <literal>error</literal> level of logging (0.2.0)
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
421 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
422
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
423 </list>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
424 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
425
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
426 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
427
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
428 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
429
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
430
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
431 </article>