Mercurial > hg > nginx-site
view xml/en/docs/njs_about.xml @ 2204:001f2d905fd9
Documented fileSystem methods in njs.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 26 Jun 2018 16:13:07 +0300 |
parents | cd4889fdcfa4 |
children | 821807549005 |
line wrap: on
line source
<?xml version="1.0"?> <!-- Copyright (C) Nginx, Inc. --> <!DOCTYPE article SYSTEM "../../../dtd/article.dtd"> <article name="About njs" link="/en/docs/njs_about.html" lang="en" rev="20"> <section id="summary"> <para> njs is a subset of the JavaScript language that allows implementing location and variable handlers in <link doc="http/ngx_http_js_module.xml">http</link> and <link doc="stream/ngx_stream_js_module.xml">stream</link>. njs is created in compliance with <link url="http://www.ecma-international.org/ecma-262/5.1/">ECMAScript 5.1</link> with some <link url="http://www.ecma-international.org/ecma-262/6.0/">ECMAScript 6</link> extensions. The compliance is still evolving. </para> </section> <section id="supported" name="What is currently supported"> <para> <list type="bullet"> <listitem> Boolean values, numbers, strings, objects, arrays, functions, and regular expressions </listitem> <listitem> ES5.1 operators, ES7 exponentiation operators </listitem> <listitem> ES5.1 statements: <literal>var</literal>, <literal>if</literal>, <literal>else</literal>, <literal>switch</literal>, <literal>for</literal>, <literal>for in</literal>, <literal>while</literal>, <literal>do while</literal>, <literal>break</literal>, <literal>continue</literal>, <literal>return</literal>, <literal>try</literal>, <literal>catch</literal>, <literal>throw</literal>, <literal>finally</literal> </listitem> <listitem> ES6 <literal>Number</literal> and <literal>Math</literal> properties and methods </listitem> <listitem> <literal>String</literal> methods: <list type="bullet"> <listitem> ES5.1: <literal>fromCharCode</literal>, <literal>concat</literal>, <literal>slice</literal>, <literal>substring</literal>, <literal>substr</literal>, <literal>charAt</literal>, <literal>charCodeAt</literal>, <literal>indexOf</literal>, <literal>lastIndexOf</literal>, <literal>toLowerCase</literal>, <literal>toUpperCase</literal>, <literal>trim</literal>, <literal>search</literal>, <literal>match</literal>, <literal>split</literal>, <literal>replace</literal> </listitem> <listitem> ES6: <literal>fromCodePoint</literal>, <literal>codePointAt</literal>, <literal>includes</literal>, <literal>startsWith</literal>, <literal>endsWith</literal>, <literal>repeat</literal> </listitem> <listitem> non-standard: <literal>fromUTF8</literal>, <literal>toUTF8</literal>, <literal>fromBytes</literal>, <literal>toBytes</literal> </listitem> </list> </listitem> <listitem> <literal>Object</literal> methods: <list type="bullet"> <listitem> ES5.1: <literal>create</literal> (support without properties list), <literal>keys</literal>, <literal>defineProperty</literal>, <literal>defineProperties</literal>, <literal>getOwnPropertyDescriptor</literal>, <literal>getPrototypeOf</literal>, <literal>hasOwnProperty</literal>, <literal>isPrototypeOf</literal>, <literal>preventExtensions</literal>, <literal>isExtensible</literal>, <literal>freeze</literal>, <literal>isFrozen</literal>, <literal>seal</literal>, <literal>isSealed</literal> </listitem> </list> </listitem> <listitem> <literal>Array</literal> methods: <list type="bullet"> <listitem> ES5.1: <literal>isArray</literal>, <literal>slice</literal>, <literal>splice</literal>, <literal>push</literal>, <literal>pop</literal>, <literal>unshift</literal>, <literal>shift</literal>, <literal>reverse</literal>, <literal>sort</literal>, <literal>join</literal>, <literal>concat</literal>, <literal>indexOf</literal>, <literal>lastIndexOf</literal>, <literal>forEach</literal>, <literal>some</literal>, <literal>every</literal>, <literal>filter</literal>, <literal>map</literal>, <literal>reduce</literal>, <literal>reduceRight</literal> </listitem> <listitem> ES6: <literal>of</literal>, <literal>fill</literal>, <literal>find</literal>, <literal>findIndex</literal> </listitem> <listitem> ES7: <literal>includes</literal> </listitem> </list> </listitem> <listitem> ES5.1 <literal>Function</literal> methods: <literal>call</literal>, <literal>apply</literal>, <literal>bind</literal> </listitem> <listitem> ES5.1 <literal>RegExp</literal> methods: <literal>test</literal>, <literal>exec</literal> </listitem> <listitem> ES5.1 <literal>Date</literal> methods </listitem> <listitem> ES5.1 <literal>JSON</literal> object </listitem> <listitem> ES5.1 global functions: <literal>isFinite</literal>, <literal>isNaN</literal>, <literal>parseFloat</literal>, <literal>parseInt</literal>, <literal>decodeURI</literal>, <literal>decodeURIComponent</literal>, <literal>encodeURI</literal>, <literal>encodeURIComponent</literal> </listitem> <listitem> <literal>Error</literal> objects: <literal>Error</literal>, <literal>EvalError</literal>, <literal>InternalError</literal>, <literal>RangeError</literal>, <literal>ReferenceError</literal>, <literal>SyntaxError</literal>, <literal>TypeError</literal>, <literal>URIError</literal> </listitem> <listitem> <literal>setTimeout()</literal> and <literal>clearTimeout()</literal> functions (0.2.0) </listitem> <listitem> <link url="https://nodejs.org/api/fs.html#fs_file_system">Node.js style</link> <literal>File system</literal> methods: <literal>fs.readFile</literal>, <literal>fs.readFileSync</literal>, <literal>fs.appendFile</literal>, <literal>fs.appendFileSync</literal>, <literal>fs.writeFile</literal>, <literal>fs.writeFileSync</literal> </listitem> <listitem> <link url="https://nodejs.org/api/crypto.html#crypto_class_hash">Node.js style</link> <literal>Crypto</literal> methods (0.2.0): <literal>crypto.createHash</literal>, <literal>crypto.createHmac</literal> </listitem> </list> </para> </section> <section id="not_supported" name="What is not supported yet"> <para> <list type="bullet"> <listitem> ES6 <literal>let</literal> and <literal>const</literal> declarations </listitem> <listitem> labels </listitem> <listitem> <literal>arguments</literal> array </listitem> <listitem> <literal>eval</literal> function </listitem> <listitem> <literal>new Function()</literal> constructor </listitem> <listitem> <literal>setInterval</literal>, <literal>setImmediate</literal> functions </listitem> <listitem> non-integer fractions (<literal>.235</literal>), binary literals (<literal>0b0101</literal>) </listitem> </list> </para> </section> <section id="changelog" name="Change Log"> <para> The complete list of njs changes is available <link doc="njs/njs_changes.xml">here</link>. </para> </section> <section id="njs_api" name="njs API Reference"> <para> njs API reference is available <link doc="njs/njs_api.xml">here</link>. </para> </section> <section id="install" name="Download and install"> <para> njs is available in two modules: <list type="bullet"> <listitem> <link doc="http/ngx_http_js_module.xml">ngx_http_js_module</link> </listitem> <listitem> <link doc="stream/ngx_stream_js_module.xml">ngx_stream_js_module</link> </listitem> </list> Both modules are not built by default, they should be either compiled from the sources or installed as a Linux package. In addition, the Linux package provides njs command-line <link id="cli">utility</link>. </para> <section id="install_package" name="Installing as a Linux package"> <para> For Linux, njs modules <link doc="../linux_packages.xml" id="dynmodules">packages</link> can be used: <list type="bullet"> <listitem> <literal>nginx-module-njs</literal> — njs <link doc="ngx_core_module.xml" id="load_module">dynamic</link> modules </listitem> <listitem> <literal>nginx-module-njs-dbg</literal> — debug symbols for the <literal>nginx-module-njs</literal> package </listitem> </list> </para> </section> <section id="install_sources" name="Building from the sources"> <para> The <link url="http://hg.nginx.org/njs">repository</link> with njs sources can be cloned with the following command: (requires <link url="https://www.mercurial-scm.org">Mercurial</link> client): <example> hg clone http://hg.nginx.org/njs </example> Then the modules should be compiled using the <literal>--add-module</literal> configuration parameter: <example> ./configure --add-module=<value>path-to-njs</value>/nginx </example> The modules can also be built as <link doc="ngx_core_module.xml" id="load_module">dynamic</link>: <example> ./configure --add-dynamic-module=<value>path-to-njs</value>/nginx </example> </para> <para> To build only njs command-line <link id="cli">utility</link>, run <literal>./configure</literal> and <literal>make njs</literal> commands from njs root directory. The utility is available as <literal>./build/njs</literal>. </para> </section> </section> <section id="cli" name="Command-line interface"> <para> njs scripts development and debugging can be performed from the command-line. The command-line utility is available after the installation of the Linux <link id="install_package">package</link> or after building from the <link id="install_sources">sources</link>. Compared to njs running inside nginx, nginx objects (<link doc="njs/njs_api.xml" id="http">HTTP</link> and <link doc="njs/njs_api.xml" id="stream">Stream</link>) are not available in the utility. <example> $ echo "2**3" | njs - 8 $ njs >> var o = {a:[]} undefined >> JSON.stringify(o, undefined,1) { "a": [ ] } >> </example> </para> </section> </article>