Bajo

Storage for applets

Config object. See Config Object for details

Storage for config handlers. By default there are only two handlers available: .js and .json.

Use plugin to add more type - e.g: bajo-config lets you to use .yaml and .toml

List of all loaded plugin's package names

Date/time when your app start

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

Break name to its namespace & path infos

Method to transform an array or object from config into an array of collection safely.

Emitted hooks:

1. {ns}:beforeBuildCollection (container) - called before collection is built
2. {ns}:afterBuildCollection (container, items) - called after collection is built

Calling any plugin's method by its name. Name format: ns:methodName.

• If name is a string, the corresponding plugin's method will be called with passed args as its parameters
• If name is a plugin instance, this will be used as the scope instead. The first args is now the handler name and the rest are its parameters
• If name is a function, this function will be run under scope with the remaining args
• If name is an object and has handler key in it, this function handler will be instead

This function iterates through all loaded plugins and call the provided handler scoped as the running plugin. And an object with the following key serves as its parameter:

• file: file matched the glob pattern
• dir: plugin's base directory

Find item deep in paths

Format value

Format value by type

Freeze object

Generate unique random characters that can be used as ID. Use nanoid under the hood

Get NPM global module directory

Get class method by name

Get module directory, locally and globally

Get plugin by name

Get plugin data directory

Resolve file path from:

• local/absolute file
• ns based path (myPlugin:/path/to/file.txt)

Get unit format

Import file/module from any loaded plugins

Your plugin structure:

|- src
|  |- lib
|  |  |- my-module.js
|- index.js
|- package.json

Inside your app/plugin:

const { importModule } = this.app.bajo
const myModule = await importModule('myPlugin:/src/lib/my-module.js')

Import one or more package belongs to a plugin

Example: you want to import packages delay and chalk from bajo namespace and use it inside your app/plugin

const { importPkg } from this.app.bajo
const [delay, chalk] = await importPkg('bajo:delay', 'bajo:chalk')

await delay(1000)
...

Check whether directory is empty or not. More info please check here.

Check whether log level is within log's app current level

Check whether directory is a valid Bajo app

Check whether directory is a valid Bajo plugin

Return its numeric portion of a value

Parse datetime string as Javascript object. Please visit dayjs for valid formats and more infos

Parse duration to its millisecond value. Use ms under the hood

Parse an object and optionally normalize its values recursively. Use https://github.com/ladjs/dotenv-parse-variables to parse values, so please have a visit to know how it works

If options.parseValue is true, any key ends with Dur and Dt will also be parsed as millisecond and Javascript datetime accordingly

Read and parse file as config object. Supported types: .js and .json. More supports can be added using plugin. bajo-config gives you additional supports for .yml, .yaml and .toml file

If file extension is .*, it will be auto detected and parsed accordingly

Read and parse json file

Resolve file name to filesystem's path. Windows path separator \ is normalized to Unix's /

Run named hook

Save item as file in Bajo's download directory. That is a directory inside your Bajo plugin's data directory.

If file exists already, file will automatically be renamed incrementally.