$ ajs
Asynchronous templating in Node.js
<% %>
<%= %>
(escape function configurable)<%- %>
-%>
ending tag<? ?>
instead of <% %>
)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:
-l, --locals <locals> The template data as JSON.
-s, --source Output the raw VM source
-t, --tree Output the abstract syntax tree
-h, --help Displays this help.
-v, --version Displays version information.
Examples:
$ ajs template.ajs
$ ajs -t template.ajs
$ ajs -s template.ajs
Documentation can be found at https://github.com/IonicaBizau/ajs#readme.
Here is an example how to use this package as library. To install it locally, as library, you can use npm install ajs
(or 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!
});
There are few ways to get help:
For full API reference, see the DOCUMENTATION.md file.
Have an idea? Found a bug? See how to contribute.
I open-source almost everything I can, and I try to reply to 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:
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6
Thanks! :heart:
Big thanks to Evan Owen who created the initial versions of the project! Amazing stuff! :cake:
If you are using this library in one of your projects, add it in this list. :sparkles:
bloggify-renderer-ajs
bloggify-ajs-renderer
bloggify-icons
blah
ajs-xgettext
express-ajs
git-stats-html