Package Exports

ajs
ajs/lib/compiler
ajs/lib/parser

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ajs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

`$ ajs`

Asynchronous templating in Node.js

Features

Control flow with <% %>
Escaped output with <%= %> (escape function configurable)
Unescaped raw output with <%- %>
Newline-trim mode ('newline slurping') with -%> ending tag
Custom delimiters (e.g., use <? ?> instead of <% %>)
Includes
Static caching of intermediate JavaScript
Static caching of templates
Complies with the Express view system

☁️ Installation

You can install the package globally and use it as command line tool:

$ npm i -g ajs

Then, run ajs --help and see what the CLI tool can do.

$ ajs --help
Usage: ajs [options]

Asynchronous templating in Node.js

Options:
  -t, --tree             Output the abstract syntax tree
  -s, --source           Output the raw VM source
  -l, --locals <locals>  The template data as JSON.
  -v, --version          Displays version information.
  -h, --help             Displays this help.

Examples:
  $ ajs template.ajs
  $ ajs -t template.ajs
  $ ajs -s template.ajs

Documentation can be found at https://github.com/IonicaBizau/ajs#readme.

📋 Example

Here is an example how to use this package as library. To install it locally, as library, you can do that using npm:

$ npm i --save ajs

const ajs = require("ajs");

ajs.render(
`<% fruits.forEach(function (c) { -%>
<%= c %>s are great
<% }) %>`, {
    locals: {
        fruits: ["Apple", "Pear", "Orange"]
    }
}, (err, data) => {
    console.log(err || data);
    // =>
    // Apples are great
    // Pears are great
    // Oranges are great
});

// Do some async stuff
ajs.render(
`<% fetchData(function (err, msg) {
   if (err) { %>
     Error: <%= err.message %>
   <% } else {
    <%= msg %>
   <% } %>
<% }) %>`, {
    locals: {
        fetchData: cb => setTimeout(
            () => cb(null, "Hey there!")
          , 1000
        )
    }
}, (err, data) => {
    console.log(err || data);
    // =>
    // Hey there!
});

📝 Documentation

For full API reference, see the DOCUMENTATION.md file.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💰 Donations

Another way to support the development of my open-source modules is to set up a recurring donation, via Patreon. 🚀

PayPal donations are appreciated too! Each dollar helps.

Thanks! ❤️

🍰 Thanks

Big thanks to Evan Owen who created the initial versions of the project! Amazing stuff! 🍰

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

ajs-xgettext (by Duane Griffin)—Extract localised text from AJS templates
bloggify-ajs-renderer—ajs renderer for Bloggify.
bloggify-icons—The Bloggify icons for the web.
express-ajs—Minimal example of how to use ajs in Express.
git-stats-html—Turn git-stats result into HTML output.

ajs