App

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

Applets container.

Program arguments.

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

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.

$ 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 } }
// }

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 anytime you want to create your own plugin, just use something like this:

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

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

Config handlers.

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

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.

Example:

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

Helper method to list all supported config formats.

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!

Example:

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

Instance of system log.

Copy of provided options.

Plugin's package names container. This is the list of plugins to load. It is read from package.json and .plugins file by default, but you can override it by providing options.plugins at constructor.

Date/time when your app start.

Start a plugin.

Stop a plugin.

App environments.

Your main namespace. And yes, you suppose to NOT CHANGE this.

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

Boot process:

• 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.

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.

Terminate the app and back to console.

Get all loaded plugin namespaces.

Get all plugins loaded plugins.

Get plugin by its namespace.

Get plugin data directory

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

Get loaded plugins.

Load internationalization & languages files for particular plugin.

Translate text and interpolate with given args.

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 name already

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

Check whether translation text/key exists