Class: App

Constructor

new App(optionsopt)

Constructor.

Parameters:

Name	Type	Attributes	Default	Description
`options`	App.TOptions	<optional>	{}	Options object.

Source: class/app.js, line 80

Members

applet :string

If app runs in applet mode, this will be the applet's name.

Type:

string

Source: class/app.js, line 170

applets :Array

Applets container.

Type:

Array

Source: class/app.js, line 114

args :Array.<string>

Parsed program arguments.

Type:

Array.<string>

Source: class/app.js, line 181
See: module:Helper.parseArgsArgv

Example

$ node index.js arg1 arg2
...
console.log(this.args) // it should print: ['arg1', 'arg2']

argv :Object

Parsed program options.

Dash (-) breaks the string into object keys
While colon (:) is used as namespace separator. If no namespace found, it is saved under _ key.

Values are parsed automatically. See dotenv-parse-variables for details.

Type:

Object

Source: class/app.js, line 207
See: module:Helper.parseArgsArgv

Example

$ node index.js --my-name-first=John --my-name-last=Doe --my-birthDay=secret --nameSpace:path-subPath=true
...
// {
//   _: {
//    my: {
//       name: { first: 'John', last: 'Doe' },
//       birthDay: 'secret'
//     }
//   },
//   nameSpace: { path: { subPath: true } }
// }

baseClass :Object

All plugin's base class are saved here as key-value pairs with plugin name as its key. The special key Base && Tools is for Base & Tools class so that anytime you want to create your own plugin, you can just write something like this:

`javascript class MyPlugin extends this.app.baseClass.Base { ... your class }

Type:

Object

Source: class/app.js, line 164

boxen :Object

Placeholder for boxen that will get imported from bajoCli later during boot process.

Type:

Object

Source: class/app.js, line 233

cache :Cache

Cache instance. This is used to store temporary data in memory for faster access.

Type:

Cache

Source: class/app.js, line 239

configHandlers :Array.<App.TConfigHandler>

Config handlers.

By default, there are three built-in handlers: .js, .json and .yml/.yaml. Use plugins to add more, e.g bajo-config lets you to use .toml.

Type:

Array.<App.TConfigHandler>

Source: class/app.js, line 130

envVars :Object

Environment variables. Support dotenv (.env) file too!

Underscore (_) translates key to camel-cased one
Double underscores (__) breaks the key into object keys
While dot (.) is used as namespace separator. If no namespace found, it is saved under _ key.

Values are also parsed automatically using dotenv-parse-variables.

E.g.:

MY_KEY=secret → { _: { myKey: 'secret' } }
MY_KEY__SUB_KEY=supersecret → { _: { myKey: { subKey: 'supersecret' } } }
MY_NS.MY_NAME=John → { myNs: { myName: 'John' } }

Type:

Object

Source: class/app.js, line 227
See: module:Helper.parseEnv

envs :App.TEnv

App environments.

Type:

App.TEnv

Source: class/app.js, line 102

lib :App.TLib

Gives you direct access to the most commonly used 3rd party library in a Bajo based app. No manual import necessary, always available, anywhere, anytime!

Type:

App.TLib

Source: class/app.js, line 141

Example

const { camelCase, kebabCase } = this.app.lib._
console.log(camelCase('Elit commodo sit et aliqua'))

log :Log

Instance of system log.

Type:

Source: class/app.js, line 150

mainNs :string

Main namespace.

Type:

string

Source: class/app.js, line 96

options :App.TOptions

Copy of provided options.

Type:

App.TOptions

Source: class/app.js, line 90

pluginPkgs :Array.<string>

Plugin's package names container. This is the list of plugins to load.

Type:

Array.<string>

Source: class/app.js, line 120

runAt :Date

Date/time when your app start.

Type:

Date

Source: class/app.js, line 108

Methods

addPlugin(plugin, baseClassopt)

Add and save plugin and it's base class definition (if provided).

Parameters:

Name	Type	Attributes	Description
`plugin`	TPlugin		A valid bajo plugin.
`baseClass`	Object	<optional>	Base class definition.

Source: class/app.js, line 258

dump(…args)

Dumping variable on screen. Like console.log with configurable options. Useful for quick debugging and testing. You can also use it to dump variables in production without worrying about performance because it is using Bajo's built-in cache to store the result of util's inspect, so it will only be processed once for each unique variable.

Any argument passed to this method will be displayed on screen. If the last argument is a boolean true, app will quit rightaway after dumping.

If you have bajoCli plugin installed, variables will be displayed in a nice box using boxen package. Otherwise, it will fallback to console.log with util's inspect result.

To have more control on how the variable is displayed, you can set options in Bajo's config under dump key. See Bajo#config for details.

Parameters:

Name	Type	Attributes	Description
`args`	any	<repeatable>	Variables to dump.

Source: class/app.js, line 386

exit(signalopt)

Terminate the app and back to console.

Parameters:

Name	Type	Attributes	Default	Description
`signal`	string \| boolean	<optional>	SIGINT	Signal to send. Set to `true` to terminate immediately without sending any signal.

Source: class/app.js, line 466

getAllNs() → {Array.<string>}

Get all loaded plugin namespaces.

Source: class/app.js, line 270

Returns:

Type:: Array.<string>

getAllPlugins() → {Array.<TPlugin>}

Get all plugins loaded plugins.

Source: class/app.js, line 292

Returns:

Type:: Array.<TPlugin>

getConfigFormats(noDotopt) → {Array.<string>}

Helper method to list all supported config formats.

Parameters:

Name	Type	Attributes	Description
`noDot`	boolean	<optional>	If `true`, it will return the list without dot prefix

Source: class/app.js, line 591

Returns:

Type:: Array.<string>

getPlugin(name, silentopt) → {Object}

Get plugin by its namespace.

Parameters:

Name	Type	Attributes	Description
`name`	string		Plugin name/namespace or alias.
`silent`	boolean	<optional>	If `true`, silently return undefined even on error.

Source: class/app.js, line 304

Returns:

Plugin object.

Type:: Object

getPluginDataDir(name, ensureDiropt) → {string}

Get plugin data directory

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			Plugin name (namespace) or alias.
`ensureDir`	boolean	<optional>	true	Set `true` (default) to ensure directory is existed.

Source: class/app.js, line 332

Returns:

Type:: string

getPluginFile(file) → {string}

Resolve file path from:

local/absolute file
TNsPath (myPlugin:/path/to/file.txt)
file under node_modules, e.g. myPlugin:node_modules/some-package/file.txt

Parameters:

Name	Type	Description
`file`	string	File path, see above for supported types.

Source: class/app.js, line 351

Returns:

Resolved file path.

Type:: string

getPlugins(nssopt) → {Array.<TPlugin>}

Get loaded plugins.

Parameters:

Name	Type	Attributes	Description
`nss`	Array.<string>	<optional>	Array of namespaces. If empty, it returns all loaded plugins.

Source: class/app.js, line 281

Returns:

Type:: Array.<TPlugin>

loadIntl(ns)

Load internationalization & languages files for particular plugin.

Parameters:

Name	Type	Description
`ns`	string	Plugin name (namespace)

Source: class/app.js, line 477

(async) run() → {Promise.<App>}

Run application:

Parsing program arguments, options and environment values
Create Bajo instance & initialize it
Run in applet mode if -a or --applet is given

After boot process is completed, event bajo:afterBootCompleted is emitted.

If app mode is applet, it runs your choosen applet instead.

Source: class/app.js, line 421

Returns:

App instance.

Type:: Promise.<App>

startPlugin(ns, …args)

Start a plugin.

Parameters:

Name	Type	Attributes	Description
`ns`	string		Plugin namespace.
`args`	any	<repeatable>	Arguments to pass to the plugin's start method

Source: class/app.js, line 603

stopPlugin(ns, …args)

Stop a plugin.

Parameters:

Name	Type	Attributes	Description
`ns`	string		Plugin namespace.
`args`	any	<repeatable>	Arguments to pass to the plugin's stop method

Source: class/app.js, line 614

t(ns, text, …params) → {string}

Translate text and interpolate with given params.

If the last parameter is an object with lang key, it will use that language instead of the default one.

There is a shortcut to this method attached on all plugins. You'll normally call that shorcut instead of this method, because it is bound to plugin's namespace already

Parameters:

Name	Type	Attributes	Description
`ns`	string		Namespace
`text`	string		Text to translate
`params`	any	<repeatable>	Arguments

Source: class/app.js, line 557

Returns:

Type:: string

Example

... within your main plugin
const translated = this.app.t('main', 'My cute cat is %s', 'purring')
// or within your plugin
const translated = this.t('My cute cat is %s', 'purring')

te(ns, text) → {boolean}

Check whether translation text/key exists.

Parameters:

Name	Type	Description
`ns`	string	Namespace
`text`	string	Text to translate

Source: class/app.js, line 579

Returns:

Type:: boolean

Type Definitions

TConfigHandler

Type:

Object

Properties

Name	Type	Attributes	Description
`ns`	string		Namespace
`ext`	string		File extension
`readHandler`	App.readHandler	<optional>	Function to call for reading
`writeHandler`	App.writeHandler	<optional>	Function to call for writing

Source: class/app.js, line 58

TEnv

Type:

Object

Properties

Name	Type	Default	Description
`dev`	string	development
`prod`	string	production

Source: class/app.js, line 33

TLib

Type:

Object

Properties

Name	Type	Description
`_`	Object	Access to lodash.
`fs`	Object	Access to fs-extra.
`fastGlob`	Object	Access to fast-glob.
`sprintf`	Object	Access to sprintf.
`aneka`	Object	Access to aneka.
`outmatch`	Object	Access to outmatch.
`dayjs`	Object	Access to dayjs with utc & customParseFormat plugin already applied.
`freeze`	Object
`findDeep`	Object

Source: lib/helper.js, line 139
See: App

TOptions

Type:

Object

Properties

Name	Type	Attributes	Description
`cwd`	string	<optional>	Set current working directory. Defaults to the script directory
`plugins`	Array.<string>	<optional>	Array of plugins to load. If provided, it override the list in `package.json` and `.plugins` file
`config`	Object	<optional>	Plugin's config object. If provided, plugin configs will no longer be read from its config files

Source: class/app.js, line 67

readHandler(text, options) → {object}

Parameters:

Name	Type	Description
`text`	string	Text to be parsed
`options`	object	Options object

Source: class/app.js, line 40

Returns:

Parsed object

Type:: object

writeHandler(data, optionsopt) → {string}

Parameters:

Name Type Attributes Default Description

data

Object

Data to be stringified

options

Object

{}

Options

Properties

Name	Type	Attributes	Default	Description
`writeToFile`	boolean	<optional>	false	If true, write result to a file
`saveAsFile`	string	<optional>		The file path to save result if writeToFile is true

Source: class/app.js, line 48

Returns:

Stringified result

Type:: string