Namespace: webconfig

NA#webconfig

Contain Webconfig file on JSON format.
Source:

Namespaces

enableLess
enableStylus

Members

(static) assetsRelativePath :string

Folder for public file like images, CSS, JS...
Type:
  • string
Default Value:
  • "assets".
Source:

(static) bundles :Object

Contain bundle configuration for CSS and JS minification in JSON format.
Type:
  • Object
Properties:
Name Type Description
bundles Object The Bundles object.
Properties
Name Type Description
javascript Object Each object name represent an output javascript file and each property of object represent an array of inputs files.
stylesheets Object Each object name represent an output stylesheets file and each property of object represent an array of inputs files.
Source:
Example
{
    "javascript": {
        "javascript/framework.min.js": [
            "javascript/modernizr.js",
            "javascript/jquery.js",
            "javascript/prettify.js",
            "javascript/prettify/run_prettify.js"
        ],
        "javascript/common.min.js": [
            "javascript/components/extended-format-date.js",
            "javascript/common.js"
        ]
    },
    "stylesheets": {
        "stylesheets/common.min.css": [
            "stylesheets/common.css",
            "stylesheets/common-min780.css",
            "stylesheets/common-min1160.css"
        ]
    }
}

(static) commonVariation :string

Name of file for `common` variation.
Type:
  • string
Source:

(static) componentsRelativePath :string

Default folder for template engine included files or controller components.
Type:
  • string
Default Value:
  • "components".
Source:

(static) controllersRelativePath :string

Controller folder for Back-end part.
Type:
  • string
Default Value:
  • "controllers".
Source:

(static) deleteSupport :boolean

Allow you to avoid or authorize DELETE response for all page.
Type:
  • boolean
Default Value:
  • false
Source:

(static) enableForceDomain :boolean

Force address and port if extra 'www' or 'port' is enter in browser url bar.
Type:
  • boolean
Default Value:
  • false
Source:

(static) enableIndex :boolean

Allow NodeAtlas to create a root page with link to all routes for development if set to true.
Type:
  • boolean
Default Value:
  • false
Source:

(static) generatesRelativePath :string

HTML assets generation Folder.
Type:
  • string
Default Value:
  • "generates".
Source:

(static) getSupport :boolean

Allow you to avoid or authorize GET response for all page.
Type:
  • boolean
Default Value:
  • true
Source:

(static) htmlGenerateEnable :boolean

Disable HTML generate mechanism.
Type:
  • boolean
Default Value:
  • false.
Source:

(static) htmlGeneratesBeforeResponse :boolean

Allow NodeAtlas to generate real file into `NA#webconfig.generatesRelativePath` directory if set to true.
Type:
  • boolean
Default Value:
  • false
Source:

(static) httpHostname :string

Server listening hostname by http.
Type:
  • string
Default Value:
  • « The webconfig's property `httpHostname` » || « The `process.env.IP_ADDRESS` if setted » || "localhost";
Source:

(static) httpPort :string

Server listening port.
Type:
  • string
Default Value:
  • « The webconfig's property `httpPort` » || « The `process.env.PORT` if setted » || 80
Source:

(static) httpSecure :boolean

Define is site is running with HTTP(S) protocol.
Type:
  • boolean
Source:

(static) httpSecureRelativeCertificatePath :string

Define the path to the Certificate for HTTPs.
Type:
  • string
Source:

(static) httpSecureRelativeKeyPath :string

Define the path to the Private Key for HTTPs.
Type:
  • string
Source:

(static) imagesOptimizationsBeforeResponse :boolean

Images optimization before each HTML response.
Type:
  • boolean
Default Value:
  • false
Source:

(static) imagesOptimizationsEnable :boolean

No images minification if set to false.
Type:
  • boolean
Default Value:
  • true
Source:

(static) injectCss :string|Array.<string>

CSS files for common injection of CSS.
Type:
  • string | Array.<string>
Source:

(static) javascriptBundlesBeforeResponse :boolean

JavaScript obfuscation before each HTML response.
Type:
  • boolean
Default Value:
  • false
Source:

(static) javascriptBundlesEnable :boolean

No JavaScript obfuscation if set to false.
Type:
  • boolean
Default Value:
  • true
Source:

(static) languageCode :string

Represent the global and main language code for website.
Type:
  • string
Default Value:
  • undefined.
Source:

(static) optimizations :Object

Contain optimizations configuration for Images optimizations.
Type:
  • Object
Properties:
Name Type Description
optimizations Object The Optimizations object.
Properties
Name Type Description
images Object Each object name represent an input image file and object value represent an output folder.
Source:
Example
{
    "jpg": { "progressive": true },
    "gif": { "interlaced": true },
    "png": { "optimizationLevel": 3 },
    "svg": { "multipass": true },
    "images": {
    "media/images/*.{gif,jpg,png,svg}": "media/images/optimized/"
    }
}

(static) pageNotFound :string

Represent route to use if no route match in all route.
Type:
  • string
Source:

(static) postSupport :boolean

Allow you to avoid or authorize POST response for all page.
Type:
  • boolean
Default Value:
  • true
Source:

(static) putSupport :boolean

Allow you to avoid or authorize PUT response for all page.
Type:
  • boolean
Default Value:
  • false
Source:

(static) routes :Object

Contain all routes on JSON format.
Type:
  • Object
Default Value:
  • The webconfig's object property `routes`.
Source:

(static) session :Object

Use a more complexe session cookie options. Replace `NA#webconfig.sessionKey` and `NA#webconfig.sessionSecret` if set.
Type:
  • Object
Source:
See:

(static) sessionKey :string

Name for Session cookie of connected user.
Type:
  • string
Default Value:
  • "nodeatlas.sid".
Source:

(static) sessionSecret :string

Secret for Session cookie of connected user.
Type:
  • string
Default Value:
  • '1234567890bépo'.
Source:

(static) staticOptions :string

Set information for static file from `assetsRelativePath`.
Type:
  • string
Source:
See:

(static) stylesheetsBundlesBeforeResponse :boolean

CSS minification before each HTML response.
Type:
  • boolean
Default Value:
  • false
Source:

(static) stylesheetsBundlesEnable :boolean

No CSS minification if set to false.
Type:
  • boolean
Default Value:
  • true
Source:

(static) templateEngineDelimiter :string

Set open and close bracket used by Teplate Engine.
Type:
  • string
Default Value:
  • '%'.
Source:

(static) templatesRelativePath :string

Template folder for Template Engine files.
Type:
  • string
Default Value:
  • "templates".
Source:

(static) urlHostname :string

Url access hostname by http (for reverse proxy).
Type:
  • string
Default Value:
  • undefined.
Source:

(static) urlPort :string

Url access port (for reverse proxy).
Type:
  • string
Default Value:
  • undefined
Source:

(static) urlRelativeSubPath :string

Adding subfolder to original url.
Type:
  • string
Default Value:
  • undefined.
Source:
Example
// If `NA#webconfig.urlRelativeSubPath` is setted to "example"
// Website will run by default to « http://localhost/example/ »

(static) urlWithoutFileName :string

Website http(s) absolute url based from `NA#webconfig.httpSecure`, `NA#webconfig.urlHostname` and `NA#webconfig.urlPort`. This value does not contain `NA#webconfig.urlRelativeSubPath`.
Type:
  • string
Source:

(static) variationsRelativePath :string

Language and variable variation files folder depending of languages.
Type:
  • string
Default Value:
  • "variations".
Source: