Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    ajspublic

    ajs

    $ ajs

    Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads

    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:

    # Using npm 
    npm install --global ajs
     
    # Using yarn 
    yarn global add 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 (or yarn):

    # Using npm 
    npm install --save ajs
     
    # Using yarn 
    yarn add 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!
    });

    ❓ Get Help

    There are few ways to get help:

    1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.

    2. For bug reports and feature requests, open issues. 🐛

    3. For direct and quick help, you can use Codementor. 🚀

    📝 Documentation

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

    😋 How to contribute

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

    💖 Support my projects

    I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

    However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

    • Starring and sharing the projects you like 🚀

    • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

    • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

    • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

    • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

    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. ✨

    📜 License

    MIT © Ionică Bizău

    install

    npm i ajs

    Downloadsweekly downloads

    160

    version

    1.2.19

    license

    MIT

    repository

    githubgithub

    last publish

    collaborators

    • avatar