Class: NA

NA()

new NA()

Creates a new instance of NodeAtlas Website.
Source:

Namespaces

controllers[]
locals
modules
webconfig

Members

(private) afterClosing :Object

Represent the function called after the server was stoped.
Type:
  • Object
Source:

(private) afterGeneration :Object

Represent the function called after all assets generation.
Type:
  • Object
Source:

(private) afterNewProject :Object

Represent the function called after create a project.
Type:
  • Object
Source:

(private) afterRunning :Object

Represent the function called after the server was started.
Type:
  • Object
Source:

(private) cliLabels :Object

All internationalize labels from `NA#cliLanguage` file.
Type:
  • Object
Source:

(private) cliLanguage :string

Name of file which contains language error messages. The name of file is without extension.
Type:
  • string
Default Value:
  • "default"
Source:

(private) configuration :Object

Represent options passed through API.
Type:
  • Object
Source:
Example
{
    path: <string>,
    webconfig: <string>,
    browse: <boolean|string>,
    httpHostname: <string>,
    httpPort: <number>,
    generate: <boolean>,
    cache: <boolean>,
    lang: <string>,
    create: <string>,
    httpSecure: <boolean|string>
}

nodeatlasModulesRelativePath :string

Folder which contain the `node-atlas` node modules.
Type:
  • string
Default Value:
  • "node_modules/"
Source:

nodeatlasPath :string

OS absolute path which contains NodeAtlas folders and files.
Type:
  • string
Default Value:
  • « The path where `node-atlas` module is. »
Source:

serverModulesRelativePath :string

Folder which contain the current website node modules.
Type:
  • string
Default Value:
  • "node_modules/"
Source:

serverPath :string

System files path to the NodeAtlas project directory (webconfig + website folder tree).
Type:
  • string
Default Value:
  • « System files path from NodeAtlas is called ».
Source:

sessionStore :Object

A default session loaded with `NA#webconfig.sessionKey` and `NA#webconfig.sessionSecret` or `NA.webconfig#sessionKey` and `NA#webconfig.session`.
Type:
  • Object
Source:
See:

version :string

Allows you to know the current version of NodeAtlas.
Type:
  • string
Source:

webconfigName :string

Name of the webconfig used for run the NodeAtlas project website.
Type:
  • string
Default Value:
  • "webconfig.json".
Source:

Methods

(private) changeDomCommon(locals, request, response, next)

Intercept DOM from common file.
Parameters:
Name Type Description
locals Object Local variables for the current page.
request Object Information from request.
response Object Information from response.
next NA~callback Next step after.
Source:

(private) changeDomSpecific(locals, request, response, next)

Intercept DOM from specific file.
Parameters:
Name Type Description
locals Object Local variables for the current page.
request Object Information from request.
response Object Information from response.
next NA~callback Next step after.
Source:

(private) changeLanguage(next)

Change the default language used by NodeAtlas CLI and keep it.
This:
Parameters:
Name Type Description
next NA~callback Called in all cases.
Source:

(private) changeVariationsCommon(locals, request, response, next)

Intercept Variation from common file.
This:
Parameters:
Name Type Description
locals Object Local variables for the current page.
request Object Information from request.
response Object Information from response.
next NA~callback Next step after.
Source:

(private) changeVariationsSpecific(locals, request, response, next)

Intercept Variation from specific file.
This:
Parameters:
Name Type Description
locals Object Local variables for the current page.
request Object Information from request.
response Object Information from response.
next NA~callback Next step after.
Source:

clone(object) → {Object}

Clone Object A into B and the purpose is : change A not affect B.
Parameters:
Name Type Description
object Object The A object.
Source:
Returns:
Return the B object.
Type
Object

close() → {Object}

Close the NA this NA instance.
This:
Source:
Returns:
The NA instance for chained functions.
Type
Object
Example
require('node-atlas')().close();

common(languageCode, locals)

Load into `{locals}.common` to object format the content of common variation file.
Parameters:
Name Type Description
languageCode string Select a subdirectory for load variation (name is generaly the languageCode).
locals object An object for attach common variation. If empty, a new empty object is created.
Source:

created(callback) → {Object}

Set private `NA#afterNewProject`.
This:
Parameters:
Name Type Description
callback function Instruction to execute after server was started.
Source:
Returns:
The NA instance for chained functions.
Type
Object
Example
require('node-atlas')().created(function () {
    // Run a server...
    // or
    // ...
}).run({
    generate: true
});

(private) createTemplateProject(next)

Copy content of a project from NodeAtlas `templates/` folder into current directory.
This:
Parameters:
Name Type Description
next NA~fallback Fallback function.
Source:

(private) createWebconfig()

Set all default webconfig's value into `NA#webconfig`.
Source:

(private) cssAlreadyParse(newPath, allCssFiles, inject)

Check if a file have been already parsed.
Parameters:
Name Type Description
newPath string Current file tested.
allCssFiles Array.<string> Files already tested.
inject string State for know if injection will be authorized.
Source:

(private) cssCompilation(next)

Engine for compile preprocessor CSS files and minify CSS output.
This:
Parameters:
Name Type Description
next NA~callback Next step after preprocessor compilation.
Source:

(private) cssMinification(next)

Engine for minification and concatenation of all files with a Bundle configuration.
This:
Parameters:
Name Type Description
next NA~callback Next step after minification and concatenation of all CSS.
Source:

(private) executeRequest(support, objectPath, options, path)

Ask for a page in GET, POST, UPDATE, DELETE or OPTIONS.
Parameters:
Name Type Description
support Object Contain all GET, POST, PUT and DELETE capability.
Properties
Name Type Description
getSupport boolean This page can be requested by GET ?
postSupport boolean This page can be requested by POST ?
putSupport boolean This page can be requested by PUT ?
deleteSupport boolean This page can be requested by DELETE ?
optionsSupport boolean This page can be requested by OPTIONS ?
objectPath string The list of Url match for obtain response.
options Object Option associate to this url.
path string The Url in routes' webconfig.
Source:

(private) exit()

Catch exit / SIGINT / uncaughtException at the end of program.
This:
Source:

express()

Instance of Express.js module.
Source:

express()

Instance of Socket.io module.
Source:

extend(…objects)

Extend an object with next object passed in param.
Parameters:
Name Type Attributes Description
objects object <repeatable>
 Each object to extend the first.
Source:

forEach(object, callback)

A safe iterator for object properties.
Parameters:
Name Type Description
object Object | Array The Object or Array to iterate.
callback forEach~callback Provide in first argument the current object, provide in second all objects.
Source:

(private) generateAssets()

Compress all assets for generate `assetsRelativePath` content into `serverlessRelativePath` and copy all `NA#statics` directories..
This:
Source:

generated(callback) → {Object}

Set private `NA#afterGeneration`.
This:
Parameters:
Name Type Description
callback function Instruction to execute after generation of generates.
Source:
Returns:
The NA instance for chained functions.
Type
Object
Example
require('node-atlas')().generated(function () {
    // Update all files on a server...
    // or
    // Generate a documentation...
    // or
    // ...
}).run({
    generate: true
});

httpServer()

The HTTP server.
Source:

httpsServer()

The HTTPs server if exist.
Default Value:
  • undefined
Source:

(private) ifFileExist(physicalPath, fileNameopt, callback)

Know if a file exist.
Parameters:
Name Type Attributes Description
physicalPath string Absolute OS path to a filename.
fileName string <optional>
 Name of file if not set in end of `physicalPath`.
callback ifFileExist~callback If file exist provide arguments `callback(null, true)` else `callback(err)` with `err` containing `path`, `physicalPath` and `filename` informations.
Source:

(private) indexPage()

Create a « Overview » page to « / » url with all of page accessible via links.
This:
Source:

init(options) → {Object}

Set private `NA#configuration`.
This:
Parameters:
Name Type Description
options Object CLI Parameters as JSON object.
Source:
Returns:
The NA instance for chained functions.
Type
Object
Example
require('node-atlas')().init({
    webconfig: "webconfig.alternatif.json",
    httpPort: 7778,
    generate: true,
    browse: true
}).start();

(private) initCliConfiguration()

Set command line options usable when NodeAtlas is executed as CLI.
This:
Source:

(private) initConfigurations(next, fallback)

Allow you to configure your own modules configuration.
This:
Parameters:
Name Type Description
next NA~callback Passed to the next function.
fallback NA~fallback Called if you want generate mode.
Source:

(private) initLessProcess()

Active Mechanism for generate Less files.
This:
Source:

(private) initMiddlewares()

Add middleware for parse request and response.
This:
Source:

initNodeModules()

Require all native modules from Node.js API required by NodeAtlas and set them into `NA#modules`.
This:
Source:

initNpmModules()

Require all NPM modules required by NodeAtlas and set them into `NA#modules`.
This:
Source:

(private) initOutputs()

Crawl all routes and generate them after passed into `NA#controllers[].setRoutes` hook.
This:
Source:

(private) initRequiredNpmModulesVars()

Set required variables for the webconfig depending of NPM modules.
This:
Source:

(private) initRequiredVars()

Set required variables for application and CLI language messages.
This:
Source:

(private) initRoutes()

Crawl all routes and execute each file with response requested by client after passed into `NA#controllers[].setRoutes` hook.
This:
Source:

(private) initServer(next, fallback)

Run the Server of NodeAtlas.
This:
Parameters:
Name Type Description
next NA~callback Called after running of server.
fallback NA~fallback Called if you want generate mode.
Source:

(private) initServerModules()

Set modules and NPM modules used by NodeAtlas project.
This:
Source:

(private) initSessions(next, fallback)

Set the Sessions variables possibility.
This:
Parameters:
Name Type Description
next NA~callback Passed to the next function.
fallback NA~fallback Called if you want generate mode.
Source:

(private) initSockets(session, optionSession, next, fallback)

Allow you to set your websocket back-end behavior.
This:
Parameters:
Name Type Description
session Object Session Object.
optionSession Object Property for Object Session.
next NA~callback Passed to the next function.
fallback NA~fallback Called if you want generate mode.
Source:

(private) initStatics()

Set the public directory for asset like CSS/JS and media.
This:
Source:

(private) initStylusProcess()

Active Mechanism for generate Stylus files.
This:
Source:

(private) initWebsite(next)

Decide to run a « Simple Web Server » or a « With Weconfig Server » depending to webconfig opening success. If webconfig is correctly openned, the `NA#createWebconfig` and `callback` function will be run, else, just `NA#simpleWebServer` will be run.
This:
Parameters:
Name Type Description
next NA~callback Called if webconfig is correctly openned.
Source:

(private) injectCss(dom, injection, mainCallback)

Inject the content of a stylesheets file into a DOM.
Parameters:
Name Type Description
dom string The ouptput HTML.
injection string | Array.<string> Represent the injectCss property injection to the template.
mainCallback injectCss~mainCallback The next steps after injection.
Source:

(private) injectCssAuth(pathFile, allCssFiles, inject)

Inject Css if not already injected.
Parameters:
Name Type Description
pathFile string Current file for injection.
allCssFiles Array.<string> Files already tested.
inject string State for know if injection will be authorized.
Source:

(private) intoBrowserAndFiles(locals, request, response, next)

Inject CSS into DOM if needed.
Parameters:
Name Type Description
locals Object Local variables for the current page.
request Object Information from request.
response Object Information from response.
next NA~callback Next step after.
Source:

(private) jsObfuscation(next)

Engine for obfuscation and concatenation of all files with a Bundle configuration.
This:
Parameters:
Name Type Description
next NA~callback Next step after obfuscation and concatenation of all CSS.
Source:

(private) lessCompilation(next)

Engine for compile Less files.
This:
Parameters:
Name Type Description
next NA~callback Next step after Less compilation.
Source:

(private) loadController(controller)

Open a controller file.
This:
Parameters:
Name Type Description
controller string The name of controller file we want to load.
Source:

(private) loadOptimizationsModules(NA)

Load all NPM modules for preproccessing, minification, obfuscation and optimization.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
Source:

(private) log(…str)

Allow you to write from CLI.
This:
Parameters:
Name Type Attributes Description
str string <repeatable>
 All sentence you want display in server-side console.
Source:

nodeAtlasWebServer(next, fallback)

Start a real NodeAtlas Server.
This:
Parameters:
Name Type Description
next NA~callback Passed to the next function.
fallback NA~fallback Called if you want generate mode.
Source:

(private) openConfiguration(configName) → {Object}

Read a JSON file and return a literal Object else kill process.
This:
Parameters:
Name Type Description
configName string File name (on file path + name in relative). Base folder is the folder where is `webconfig.json`.
Source:
Returns:
Literal object of JSON file.
Type
Object

(private) openVariation(variationName, languageCode, errorDisabled) → {Object|boolean}

Open a variation file.
This:
Parameters:
Name Type Description
variationName string Name of JSON file.
languageCode string Current language for this variation.
errorDisabled boolean | undefined Force no error message.
Source:
Returns:
Return all data from JSON or false if an error occured.
Type
Object | boolean

(private) openView(routeParameters, viewsPath, callback)

Open a temlpate file.
This:
Parameters:
Name Type Description
routeParameters Object Parameters set into `routes[]`.
viewsPath Object Path to template file.
callback openView~callback Next steps after opening file.
Source:

(private) pageNotFound()

Define a page to display when no url match in route or in directories provided by `NA#initStatics`.
This:
Source:

(private) prepareCssInjection(allCssFiles, injection)

Verify if common or specif file without double are ready for injection CSS.
Parameters:
Name Type Description
allCssFiles Array.<string> Files already tested.
injection string | Array.<string> Represent the injectCss property injection to the template.
Source:

(private) prepareHeaders(locals, request, response, next)

Set all webconfig headers.
This:
Parameters:
Name Type Description
locals Object Local variables for the current page.
request Object Information from request.
response Object Information from response.
next NA~callback Next step after.
Source:

(private) prepareRenderLanguage(locals, request, response, next)

Create some variable for manage path for render.
This:
Parameters:
Name Type Description
locals Object Local variables for the current page.
request Object Information from request.
response Object Information from response.
next NA~callback Next step after.
Source:

(private) prepareRenderPath(locals, request, response, next)

Create some variable for manage path for render.
This:
Parameters:
Name Type Description
locals Object Local variables for the current page.
request Object Information from request.
response Object Information from response.
next NA~callback Next step after.
Source:

(private) prepareRenderVariation(locals, request, response, next)

Create some variable for manage variation into render.
This:
Parameters:
Name Type Description
locals Object Local variables for the current page.
request Object Information from request.
response Object Information from response.
next NA~callback Next step after.
Source:

(private) prepareResponse(path, options, request, response, next)

Get all information to prepare the response.
This:
Parameters:
Name Type Description
path string The url listening.
options Object Option associate to this url.
request Object Initial request.
response Object Initial response.
next NA~callback Next step after.
Source:

(private) publicsGeneration(next)

Copy all `public` file from `assetsRelativePath` to `serverlessRelativePath`.
This:
Parameters:
Name Type Description
next NA~callback Next step after copy of all `assetsRelativePath` content.
Source:

(private) redirect(routeParameters, request, response)

Redirect a page to an other page if option page is set for that.
Parameters:
Name Type Description
routeParameters Object All information associate with the redirection.
request Object Initial request.
response Object Initial response.
Source:

(private) renderTemplate(data, locals, request, response, next)

Write file or/and send response.
Parameters:
Name Type Description
data string HTML DOM ready for sending.
locals Object Local variables for the current page.
request Object Information from request.
response Object Information from response.
next NA~callback Next step after.
Source:

(private) request(path, options)

Listen a specific request.
This:
Parameters:
Name Type Description
path string The url listening.
options Object Options associate to this url.
Source:

(private) requestRegex(support, objectPath, options, path, routeParameters)

Listen a specific request (Regex Part).
Parameters:
Name Type Description
support Object Contain all GET, POST, PUT, DELETE or OPTIONS capability.
Properties
Name Type Description
getSupport boolean This page can be requested by GET ?
postSupport boolean This page can be requested by POST ?
putSupport boolean This page can be requested by PUT ?
deleteSupport boolean This page can be requested by DELETE ?
optionsSupport boolean This page can be requested by OPTIONS ?
objectPath string The list of Url match for obtain response.
options Object Option associate to this url.
path string The Url in routes' webconfig.
routeParameters Object Parameters for this route.
Source:

run(options) → {Object}

Execute both `NA#init()` and `NA#start()` functions.
This:
Parameters:
Name Type Description
options Object CLI Parameters as JSON object.
Source:
Returns:
The NA instance for chained functions.
Type
Object
Example
require('node-atlas').run({
       webconfig: "webconfig.alternatif.json",
       httpPort: 7778,
       generate: true
});

(private) saveRender(data, templateName)

Generate a template into an HTML file in folder `serverlessRelativePath`.
This:
Parameters:
Name Type Description
data string Content of file generated.
templateName string The filename of file generated.
Source:

(private) sendResponse(request, response, data, next)

Send HTML result to the client.
Parameters:
Name Type Description
request Object Initial request.
response Object Initial response.
data string HTML DOM ready for sending.
next NA~callback Next step after.
Source:

server()

The Server used to listen.
Source:

(private) simpleWebServer()

Run project folder with targeted directory (without webconfig) as a « public » directory.
This:
Source:

specific(specific, languageCode, locals)

Load into `{locals}.specific` to object format the content of a specific variation file.
Parameters:
Name Type Description
specific string Select the specific variation associate to the current page.
languageCode string Select a subdirectory for load variation (name is generaly the languageCode).
locals object An object for attach specific variation. If empty, a new empty object is created.
Source:

start() → {Object}

Initialize a NA instance.
This:
Source:
Returns:
The NA instance for chained functions.
Type
Object
Example
require('node-atlas')().start();

started(callback) → {Object}

Set private `NA#afterRunning`.
This:
Parameters:
Name Type Description
callback function Instruction to execute after started a webserver.
Source:
Returns:
The NA instance for chained functions.
Type
Object
Example
require('node-atlas')().started(function () {
    // Run another server...
    // or
    // ...
}).run({
    generate: true
});

(private) staticsGeneration(next)

Copy all `statics` form real directory to `serverlessRelativePath`.
This:
Parameters:
Name Type Description
next NA~callback Next step after copy of all `assetsRelativePath` content.
Source:

stopped(callback) → {Object}

Set private `NA#afterClosing`.
This:
Parameters:
Name Type Description
callback function Instruction to execute after server was stopped.
Source:
Returns:
The NA instance for chained functions.
Type
Object
Example
require('node-atlas')().stopped(function () {
    // Re-run server...
    // or
    // ...
}).start();

(private) stylusCompilation(next)

Engine for compile Stylus files.
This:
Parameters:
Name Type Description
next NA~callback Next step after Stylus compilation.
Source:

view(viewFile, locals)

Load a HTML fragment and inject variation for an async result.
Parameters:
Name Type Description
viewFile string Path of file used into viewsRelativePath directory.
locals object Local variables used for transform view + locals into HTML.
Source:

(private, inner) addBackSockets(NA)

Set the Hooks for Controllors.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
Source:

(private, inner) addFrontSockets(NA)

Deliver NA.io to the client-side.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
Source:

(private, inner) cliServerUp(NA, urlOutput, message)

Inform CLI when the server is up.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
urlOutput string URL default access for website.
message string Details provide with URL.
Source:

(private, inner) engineProcess(NA, view, engine, locals, response, next)

Choose an engine to parse view.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
view string View to parse.
engine string Engine to parse.
locals Object Local variables for the current page.
response Object Information from response.
next NA~callback Next step after.
Source:

(private, inner) errorServer(NA)

Catch error from server.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
Source:

(private, inner) explainError(NA, err, variationName, languageCode, errorDisabled)

Intercept DOM from common file.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
err Object Error to explain.
variationName string Name of JSON file.
languageCode string Current language for this variation.
errorDisabled boolean | undefined Force no error message.
Source:

(private, inner) generateHTML(NA)

Open all pages for generate HTML render into `serverlessRelativePath`.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
Source:

(private, inner) getMiddlewares(NA, routeParameters) → {function}

Create Middleware function.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
routeParameters Object Parameters for route.
Source:
Returns:
Preparation middleware.
Type
function

(private, inner) lessStoreCss(NA, regex)

CSS generate from Less files.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
regex RegExp Used for change pathname.
Source:

(private, inner) lessStoreSourcemap(NA, regex)

Source Map for Less files.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
regex RegExp Used for change pathname.
Source:

(private, inner) loadHtmlModules(NA)

Load all NPM modules for manipulate HTML render.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
Source:

(private, inner) loadRoutes(NA)

Add route to express.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
Source:

(private, inner) loadServerModules(NA)

Load all NPM modules to run a Web Server.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
Source:

(private, inner) loadUtilsModules(NA)

Load all NPM modules to enhance NodeAtlas.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
Source:

(private, inner) manageHeaders(NA, headers, response)

Add and Remove headers from Webconfig.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
headers Object All headers from webconfig.
response Object All stuff for HTTP response.
Source:

(private, inner) noCache(NA, nocache, staticOptions)

Set information to avoid cache.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
nocache boolean No cache if set to true.
staticOptions Object All options for publics file cache.
Source:

(private, inner) prepare(NA, path, options) → {function}

Prepare locals and headers.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
path Object Key/Path for routes.
options boolean Value(s) for routes.
Source:
Returns:
Preparation middleware.
Type
function

(private, inner) prepareEngineProcess(NA, locals, response, next)

Prepare the choosen engine to parse view.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
locals Object Local variables for the current page.
response Object Information from response.
next NA~callback Next step after.
Source:

(private, inner) redirect(NA, routeParameters) → {function}

If page must be redirected.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
routeParameters Object Parameters for route.
Source:
Returns:
Preparation redirect.
Type
function

(private, inner) redirect(NA) → {function}

If page must be redirected.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
Source:
Returns:
Preparation middleware.
Type
function

(private, inner) save(NA, html, data, templateName)

Save the render.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
html string HTML result to save.
data string Result if html is not a HTML content.
templateName string Name for register file.
Source:

(private, inner) serverListener(NA, httpPort, urlOutput, messageCode, next)

Listen the port.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
httpPort number Port used by application.
urlOutput number The url Output.
messageCode number For find the correct JSON message.
next NA~callback After server listenning.
Source:

(private, inner) setSupport(support, path, options) → {boolean}

Affect support of GET, POST, UPDATE, DELETE and OPTIONS to a route.
Parameters:
Name Type Description
support boolean Type of support GET, POST, PUT, DELETE or OPTIONS.
path boolean Instruction support for all page.
options boolean Instruction support for current page.
Source:
Returns:
if support is effective;
Type
boolean

(private, inner) setWebconfigCompressions()

Set bundles and optimizations.
Source:

(private, inner) setWebconfigDirectories()

Set NodeAtlas directory names.
Source:

(private, inner) setWebconfigHeaders()

Set the mimeType, charset and headers.
Source:

(private, inner) setWebconfigHost()

Set HTTP Port and HTTP hostname.
Source:

(private, inner) setWebconfigPreprocessors()

Set pug, less and enbaleStylus.
Source:

(private, inner) setWebconfigRoutes()

Set routes, statics and prefix routes.
Source:

(private, inner) setWebconfigSecure()

Set default Cache and Secure.
Source:

(private, inner) simpleServerUrlOutput(NA, httpPort)

Calculate the url output for simple web server.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
httpPort number Port used by application.
Source:
Returns:
The url Output.

(private, inner) supportDelete(NA, routeParameters, deleteSupport) → {boolean}

Set parameters authorization.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
routeParameters Object Parameters set into `routes[]`.
deleteSupport boolean Represent initial state of support.
Source:
Returns:
if support is effective;
Type
boolean

(private, inner) supportGet(NA, routeParameters, getSupport) → {boolean}

Set parameters authorization.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
routeParameters Object Parameters set into `routes[]`.
getSupport boolean Represent initial state of support.
Source:
Returns:
if support is effective;
Type
boolean

(private, inner) supportOptions(NA, routeParameters, optionsSupport) → {boolean}

Set parameters authorization.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
routeParameters Object Parameters set into `routes[]`.
optionsSupport boolean Represent initial state of support.
Source:
Returns:
if support is effective;
Type
boolean

(private, inner) supportPost(NA, routeParameters, postSupport) → {boolean}

Set parameters authorization.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
routeParameters Object Parameters set into `routes[]`.
postSupport boolean Represent initial state of support.
Source:
Returns:
if support is effective;
Type
boolean

(private, inner) supportPut(NA, routeParameters, putSupport) → {boolean}

Set parameters authorization.
Parameters:
Name Type Description
NA NA NodeAtlas instance.
routeParameters Object Parameters set into `routes[]`.
putSupport boolean Represent initial state of support.
Source:
Returns:
if support is effective;
Type
boolean

(private, inner) traverse(paths, next)

Copy mechanism for statics.
This:
Parameters:
Name Type Description
paths Object Contain a `statics` content.
Properties
Name Type Description
real string The path of source directory.
virtual string The path of virtual url.
output boolean Inform if copy is required
next NA~callback Go to next steps.
Source:

Type Definitions

callback()

Continue after synchronous/asynchronous operations done.
Source:

fallback()

Continue with this alternative way if main operation not possible.
Source: