API / NodeAtlas comme module npm

Vous pouvez lancez NodeAtlas via du code JavaScript.

L'intégralité des fonctions privées, modules et espaces de nom de NodeAtlas sont décrit dans la documentation de l'API (En). En ce qui concerne les Points d'ancrage c'est par ici et pour les fonctions de démarrage du serveur c'est ci-dessous :

<NA>.start()

Exécuté un simple lancement de NodeAtlas avec start(). Par défaut il cherchera le webconfig.json dans le dossier où le script est exécuté. Si aucun webconfig.json n'est trouvé, un Simple Serveur Web sera lancé.

server.js

require("node-atlas")().start();

$ node server.js

<NA>.init(options)

Vous pouvez également configurer le lancement avec init(options) :

server.js

require("node-atlas")().init({
    path: "/path/to/your/website/directory/",
    webconfig: "webconfig.alternatif.json",
    browse: true,
    httpHostname: "192.168.1.1",
    httpPort: 7778,
    generate: true
}).start();

$ node server.js

L'objet options est le suivant :

{
    path: <string>,
    webconfig: <string>,
    browse: <boolean|string>,
    httpHostname: <string>,
    httpPort: <number>,
    generate: <boolean>,
    cache: <boolean>,
    lang: <string>,
    create: <string>,
    httpSecure: <boolean|string>
}

Note : plus de détails pour chaque option dans la partie CLI.

<NA>.run(options)

Avec run(options) vous pouvez configurer et lancer NodeAtlas en une commande.

Vous pouvez par exemple lancer plusieurs sites en une fois. Bien entendu, chaque webconfig écoutera un port différent.

servers.js

var nodeAtlas = require("node-atlas"),
    websiteEn = new nodeAtlas(),
    websiteFr = new nodeAtlas();

websiteEn.run({
    "browse": true,
    "webconfig": "webconfig.english.json"
});
websiteFr.run({
    "browse": true,
    "webconfig": "webconfig.french.json"
});

<NA>.started(callback)

Avec started(callback), vous pouvez aussi exécuter d'autres tâches après que le serveur web soit lancé :

servers.js

require("node-atlas")().started(function() {
    console.log("Server started!");
}).run({
    browse: true
});

<NA>.stopped(callback)

Avec stopped(callback), vous pouvez aussi exécuter d'autres tâches après que le serveur web soit stoppé :

servers.js

require("node-atlas")().stopped(function() {
    console.log("Server stopped!");
}).start();

<NA>.generated(callback)

Avec generated(callback), vous pouvez aussi exécuter d'autres tâches après la génération de vos assets :

servers.js

require("node-atlas")().generated(function() {
    require('child_process').exec(__dirname + "/documentation.bat", function (err, stdout, stderr) {
        console.log("Documentation generation...");
        console.log(stdout);
        console.log("Documentation generation done!");
    });
}).run({
    generate: true
});

<NA>.created(callback)

Avec created(callback), vous pouvez aussi exécuter d'autres tâches après avoir initialisé le répertoire courant avec un site template :

servers.js

var nodeAtlas = require("node-atlas"),
    website = nodeAtlas();

website.init({
    "init": true
}).created(function() {
    website.run({
        "browse": true
    });
}).start();