annotate xml/en/docs/njs/index.xml @ 2541:0e6bbd8138c4

Added article about TypeScript in njs.
author Yaroslav Zhuravlev <yar@nginx.com>
date Fri, 15 May 2020 16:22:43 +0100
parents 73d254c3376d
children 5b2764724e0d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
2
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
3 <!--
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
4 Copyright (C) Nginx, Inc.
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
5 -->
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
6
2244
467aef18bf12 Renamed the "About njs" page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2229
diff changeset
7 <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd">
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
8
2244
467aef18bf12 Renamed the "About njs" page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2229
diff changeset
9 <article name="njs scripting language"
467aef18bf12 Renamed the "About njs" page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2229
diff changeset
10 link="/en/docs/njs/index.html"
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
11 lang="en"
2541
0e6bbd8138c4 Added article about TypeScript in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2480
diff changeset
12 rev="29"
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
13 toc="no">
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
14
2270
cd9934924920 Moved summary to top of njs index page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2263
diff changeset
15 <section id="summary">
cd9934924920 Moved summary to top of njs index page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2263
diff changeset
16
cd9934924920 Moved summary to top of njs index page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2263
diff changeset
17 <para>
cd9934924920 Moved summary to top of njs index page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2263
diff changeset
18 njs is a subset of the JavaScript language that allows
cd9934924920 Moved summary to top of njs index page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2263
diff changeset
19 extending nginx functionality.
cd9934924920 Moved summary to top of njs index page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2263
diff changeset
20 njs is created in compliance with
cd9934924920 Moved summary to top of njs index page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2263
diff changeset
21 <link url="http://www.ecma-international.org/ecma-262/5.1/">ECMAScript 5.1</link>
cd9934924920 Moved summary to top of njs index page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2263
diff changeset
22 (strict mode) with some
cd9934924920 Moved summary to top of njs index page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2263
diff changeset
23 <link url="http://www.ecma-international.org/ecma-262/6.0/">ECMAScript 6</link>
cd9934924920 Moved summary to top of njs index page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2263
diff changeset
24 and later extensions.
cd9934924920 Moved summary to top of njs index page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2263
diff changeset
25 The compliance is still <link doc="compatibility.xml">evolving</link>.
cd9934924920 Moved summary to top of njs index page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2263
diff changeset
26 </para>
cd9934924920 Moved summary to top of njs index page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2263
diff changeset
27
cd9934924920 Moved summary to top of njs index page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2263
diff changeset
28 </section>
cd9934924920 Moved summary to top of njs index page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2263
diff changeset
29
cd9934924920 Moved summary to top of njs index page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2263
diff changeset
30
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
31 <section id="links">
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
32
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
33 <para>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
34 <list type="bullet">
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
35
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
36 <listitem>
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
37 <link doc="install.xml"/>
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
38 </listitem>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
39
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
40 <listitem>
2246
32ba43abf9cd Renamed njs API, njs Changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2245
diff changeset
41 <link doc="changes.xml"/>
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
42 </listitem>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
43
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
44 <listitem>
2246
32ba43abf9cd Renamed njs API, njs Changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2245
diff changeset
45 <link doc="reference.xml"/>
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
46 </listitem>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
47
2004
d1a1253a570e Documented Object methods, exponential and hex literals in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1955
diff changeset
48 <listitem>
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
49 <link doc="examples.xml"/>
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
50 </listitem>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
51
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
52 <listitem>
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
53 <link doc="compatibility.xml"/>
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
54 </listitem>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
55
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
56 <listitem>
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
57 <link doc="cli.xml"/>
2071
838c503fd2f7 Documented JSON object support for njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2026
diff changeset
58 </listitem>
838c503fd2f7 Documented JSON object support for njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2026
diff changeset
59
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
60 </list>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
61 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
62
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
63 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
64 <list type="bullet">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
65
2071
838c503fd2f7 Documented JSON object support for njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2026
diff changeset
66 <listitem>
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
67 <link doc="../http/ngx_http_js_module.xml">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
68 ngx_http_js_module</link>
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
69 </listitem>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
70
2076
07239ff77f50 Updated supported functionality for nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2071
diff changeset
71 <listitem>
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
72 <link doc="../stream/ngx_stream_js_module.xml">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
73 ngx_stream_js_module</link>
2129
4212f4520070 Updated "About njs" with methods supported in njs-0.2.0.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2128
diff changeset
74 </listitem>
4212f4520070 Updated "About njs" with methods supported in njs-0.2.0.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2128
diff changeset
75
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
76 </list>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
77 </para>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
78
2541
0e6bbd8138c4 Added article about TypeScript in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2480
diff changeset
79 <para>
0e6bbd8138c4 Added article about TypeScript in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2480
diff changeset
80 <list type="bullet">
0e6bbd8138c4 Added article about TypeScript in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2480
diff changeset
81
0e6bbd8138c4 Added article about TypeScript in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2480
diff changeset
82 <listitem>
0e6bbd8138c4 Added article about TypeScript in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2480
diff changeset
83 <link doc="typescript.xml"/>
0e6bbd8138c4 Added article about TypeScript in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2480
diff changeset
84 </listitem>
0e6bbd8138c4 Added article about TypeScript in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2480
diff changeset
85
0e6bbd8138c4 Added article about TypeScript in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2480
diff changeset
86 <listitem>
0e6bbd8138c4 Added article about TypeScript in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2480
diff changeset
87 <link doc="node_modules.xml"/>
0e6bbd8138c4 Added article about TypeScript in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2480
diff changeset
88 </listitem>
0e6bbd8138c4 Added article about TypeScript in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2480
diff changeset
89
0e6bbd8138c4 Added article about TypeScript in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2480
diff changeset
90 </list>
0e6bbd8138c4 Added article about TypeScript in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2480
diff changeset
91 </para>
0e6bbd8138c4 Added article about TypeScript in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2480
diff changeset
92
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
93 </section>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
94
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
95
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
96 <section id="usecases" name="Use cases">
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
97
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
98 <para>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
99 <list type="bullet">
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
100
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
101 <listitem>
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
102 Complex access control and security checks in njs
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
103 before a request reaches an upstream server
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
104 </listitem>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
105
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
106 <listitem>
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
107 Manipulating response headers
2150
af5751930f95 Described new Function() as not supported in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2148
diff changeset
108 </listitem>
af5751930f95 Described new Function() as not supported in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2148
diff changeset
109
af5751930f95 Described new Function() as not supported in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2148
diff changeset
110 <listitem>
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
111 Writing flexible asynchronous content handlers and filters
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
112 </listitem>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
113
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
114 </list>
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
115 See <link doc="examples.xml">examples</link> and
2280
dce69c8e4c7d A link to the njs blogposts fixed.
Maxim Konovalov <maxim@nginx.com>
parents: 2270
diff changeset
116 <link url="https://www.nginx.com/blog/tag/nginx-javascript-module/">blog posts</link>
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
117 for more njs use cases.
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
118 </para>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
119
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
120 </section>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
121
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
122
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
123 <section id="example" name="Basic HTTP Example">
2130
302fbdd94a04 Added njs changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2129
diff changeset
124
302fbdd94a04 Added njs changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2129
diff changeset
125 <para>
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
126 To use njs in nginx:
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
127 <list type="bullet">
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
128
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
129 <listitem>
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
130 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
131 <link doc="install.xml">install</link> njs scripting language
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
132 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
133 </listitem>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
134
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
135 <listitem id="hello_world">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
136 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
137 create an njs script file, for example, <path>hello_world.js</path>.
2246
32ba43abf9cd Renamed njs API, njs Changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2245
diff changeset
138 See <link doc="reference.xml">Reference</link>
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
139 for the list of njs properties and methods.
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
140 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
141 function hello(r) {
2257
8cef5ef98336 Changed quotes to ASCII in NJS example.
Nick Shadrin <nick@nginx.com>
parents: 2246
diff changeset
142 r.return(200, "Hello world!");
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
143 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
144 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
145 </para>
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
146 </listitem>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
147
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
148 <listitem>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
149
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
150 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
151 in the <path>nginx.conf</path> file, enable
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
152 <link doc="../http/ngx_http_js_module.xml">ngx_http_js_module</link> module
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
153 and specify the
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
154 <link doc="../http/ngx_http_js_module.xml" id="js_include">js_include</link>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
155 directive
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
156 with the <path>hello_world.js</path> script file:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
157 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
158 load_module modules/ngx_http_js_module.so;
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
159
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
160 events {}
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
161
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
162 http {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
163 js_include hello_world.js;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
164
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
165 server {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
166 listen 8000;
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
167
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
168 location / {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
169 js_content hello;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
170 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
171 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
172 }
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
173
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
174 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
175 </para>
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
176 </listitem>
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
177
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
178 </list>
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
179 There is also a standalone <link doc="cli.xml">command line</link> utility
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
180 that can be used independently of nginx for njs development and debugging.
2174
3b782a679237 Mentioned njs CLI in "About njs".
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2150
diff changeset
181 </para>
3b782a679237 Mentioned njs CLI in "About njs".
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2150
diff changeset
182
3b782a679237 Mentioned njs CLI in "About njs".
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2150
diff changeset
183 </section>
3b782a679237 Mentioned njs CLI in "About njs".
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2150
diff changeset
184
2263
1bec6f727a84 Added njs presentation from nginx.conf 2018.
Valentin Bartenev <vbart@nginx.com>
parents: 2257
diff changeset
185
1bec6f727a84 Added njs presentation from nginx.conf 2018.
Valentin Bartenev <vbart@nginx.com>
parents: 2257
diff changeset
186 <section id="presentation" name="Presentation at nginx.conf 2018">
1bec6f727a84 Added njs presentation from nginx.conf 2018.
Valentin Bartenev <vbart@nginx.com>
parents: 2257
diff changeset
187
1bec6f727a84 Added njs presentation from nginx.conf 2018.
Valentin Bartenev <vbart@nginx.com>
parents: 2257
diff changeset
188 <para><video id="Jc_L6UffFOs" /></para>
1bec6f727a84 Added njs presentation from nginx.conf 2018.
Valentin Bartenev <vbart@nginx.com>
parents: 2257
diff changeset
189
1bec6f727a84 Added njs presentation from nginx.conf 2018.
Valentin Bartenev <vbart@nginx.com>
parents: 2257
diff changeset
190 </section>
1bec6f727a84 Added njs presentation from nginx.conf 2018.
Valentin Bartenev <vbart@nginx.com>
parents: 2257
diff changeset
191
1846
bfac366fa1e4 Added article about nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
192 </article>