aegisblade

AegisBlade Node.js Client

The node.js client library for AegisBlade.
Read the docs »

Examples · Sign Up for an API Key · Report Bug

Installation

Install the npm package as a dependency of your application.

npm install --save aegisblade

Hello World Example

const {aegisblade} = require('aegisblade');
const os = require("os");
 
/**
 * In this example the `helloWorld()` function will be run on a
 * server using AegisBlade. 
 */
async function helloWorld() {
    console.log(`The server's hostname is ${os.hostname()}`);
 
    return `Hello World from ${os.hostname()}`;
}
 
// Any target function to be run on AegisBlade must be exported.
module.exports = {helloWorld};
 
/**
 * The `main()` function will run on your local machine
 * and start the job running the `helloWorld()` function
 * on a server using AegisBlade.
 */
async function main() {
    let job = await aegisblade.run(helloWorld);
    
    console.log(`Job Id: ${job.id}`);
    console.log("Waiting for the job to finish running...");
 
    let jobReturnValue = await job.getReturnValue();
    let jobLogs = await job.getLogs();
 
    console.log(`Job Return Value: ${jobReturnValue}`);
    console.log(`Job Logs: ${jobLogs}`);
}
 
//  Using the `require.main === module` idiom to only run main when this script
//    is called directly is especially important when using AegisBlade to prevent
//    infinite loops of jobs creating jobs.
if (require.main === module) {
    (async () => {
        try {
            await main();
        } catch (err) {
            console.error(err);
        }
    })();
}