@genx/app

Global

Members

<readonly> module:Feature :string

Feature level definitions.

Type:
  • string
Properties:
Name Type Default Description
CONF string Configure

Configuration
INIT string Initial

Initialization, e.g. settings
SERVICE string Services

Services, e.g. loggers, i18n
PLUGIN string Plugins

Loading plugins, e.g. middlewares, bootstrap
READY string Ready

Final preparation before service container get into work
validate string

Validate a feature object.
Source:
enum/Feature.js

<readonly> module:Literal :string

Common constant definitions.

Type:
  • string
Properties:
Name Type Default Description
DEFAULT_CONFIG_PATH string conf

Config files path
FEATURES_PATH string features

Feature files path
APP_CFG_NAME string app

App config file name
DEFAULT_BOOTSTRAP_PATH string bootstrap

Default bootrap path
DEFAULT_TIMEZONE string Australia/Sydney

Default timezone
MODELS_PATH string models

Models files path, under backend folder
Source:
enum/Literal.js

Methods

<async> startLoopWorker(worker, options)

Parameters:
Name Type Description
worker function
options object
Properties:
Name Type Argument Default Description
options.interval integer <optional>
 1000
Source:
starters/loopWorker.js

<async> startQueueWorker(worker, queueService, queueName, options)

Start a message queue worker.

Parameters:
Name Type Description
worker function
queueService *
queueName *
options object
Source:
starters/queueWorker.js

<async> startWorker(worker [, workerOptions])

Start a worker app

Parameters:
Name Type Argument Description
worker function
workerOptions object <optional>
Properties:
Name Type Argument Description
workerOptions.workerName string <optional>
workerOptions.dontStop boolean <optional>

Don't stop after worker done
workerOptions.initializer function <optional>
Source:
starters/worker.js