About nginScript

• What is currently supported
• What is not supported yet
• Download and install
• Installing as a Linux package
• Building from the sources

nginScript is a subset of the JavaScript language that allows implementing location and variable handlers in http and stream. nginScript is created in compliance with ECMAScript 5.1 with some ECMAScript 6 extensions. The compliance is still evolving.

What is currently supported

• Boolean values, numbers, strings, objects, arrays, functions, and regular expressions
• ES5.1 operators, ES7 exponentiation operators
• ES5.1 statements: var, if, else, switch, for, for in, while, do while, break, continue, return, try, catch, throw, finally
• ES6 Number and Math properties and methods
• String methods:
  • ES5.1: fromCharCode, concat, slice, substring, substr, charAt, charCodeAt, indexOf, lastIndexOf, toLowerCase, toUpperCase, trim, search, match, split, replace
  • ES6: fromCodePoint, codePointAt, includes, startsWith, endsWith, repeat
  • non-standard: fromUTF8, toUTF8, fromBytes, toBytes
• Object methods:
  • ES5.1: create (support without properties list), keys, defineProperty, defineProperties, getOwnPropertyDescriptor, getPrototypeOf, hasOwnProperty, isPrototypeOf, preventExtensions, isExtensible, freeze, isFrozen, seal, isSealed
• Array methods:
  • ES5.1: isArray, slice, splice, push, pop, unshift, shift, reverse, sort, join, concat, indexOf, lastIndexOf, forEach, some, every, filter, map, reduce, reduceRight
  • ES6: of, fill, find, findIndex
  • ES7: includes
• ES5.1 Function methods: call, apply, bind
• ES5.1 RegExp methods: test, exec
• ES5.1 Date methods
• ES5.1 JSON object
• ES5.1 global functions: isFinite, isNaN, parseFloat, parseInt, decodeURI, decodeURIComponent, encodeURI, encodeURIComponent
• Error objects: Error, EvalError, InternalError, RangeError, ReferenceError, SyntaxError, TypeError, URIError
• File system methods (Node.js style): fs.readFile, fs.readFileSync, fs.appendFile, fs.appendFileSync, fs.writeFile, fs.writeFileSync

What is not supported yet

• ES6 let and const declarations
• labels
• arguments array
• eval function
• setTimeout, setInterval, setImmediate functions
• non-integer fractions (.235), binary literals (0b0101)

Download and install

nginScript is available in two modules:

• ngx_http_js_module
• ngx_stream_js_module

Both modules are not built by default, they should be either compiled from the sources or installed as a Linux package.

Installing as a Linux package

For Linux, nginScript modules packages can be used:

• nginx-module-njs — nginScript dynamic modules
• nginx-module-njs-dbg — debug symbols for the nginx-module-njs package

Building from the sources

The repository with nginScript sources can be cloned with the following command: (requires Mercurial client):

hg clone http://hg.nginx.org/njs

Then the modules should be compiled using the --add-module configuration parameter:

./configure --add-module=path-to-njs/nginx

The modules can also be built as dynamic:

./configure --add-dynamic-module=path-to-njs/nginx