Bajo

Alias. Read-only

Configuration object

Hooks container. This is where all hooks definition are stored.

Array of white space characters. Used to trim strings

Bajo boot process. This method is called by the App class during the app's boot process:

1. Ensure directories are there and exist
2. Collect all plugins available plugins
3. Collect all config handlers from all loaded plugins
4. Build configuration object
5. Building plugins listed in package.json or .plugins file
6. Determining the boot order
7. Ensure the uniqueness of all plugins' name and alias
8. Ensure all plugins dependencies are met
9. Collect all hooks from all loaded plugins
10. Run all plugins according to the boot order
11. And finally attaching all exit handlers it could find

Break name to their components.

If path starts with //, e.g. name is https://example.com, it will be treated as a URL and returned as an object with only path property filled with the original name.

If query string is present in the path, it will be parsed and returned as an object with qs property containing the parsed query string.

If path contains parameters in the format of :key|value or {key|value}, they will be extracted and returned as an object with params property containing the extracted parameters.

This method is one of the most used method in Bajo. It is because every files, names, resources, and even commands are all identified by their namespace and path.

Break file path to its namespace & path infos.

Method to transform config's array or object into a collection of objects with uniformed structure. This is useful to build a collection of items from config's array or object, e.g. a collection of commands, routes, etc.

You typically also provide a handler function to transform each item in the collection. The handler function will be called with an object containing the following keys:

• item: the current item in the collection
• index: the index of the current item in the collection
• cfg: the entire config object

Build ns/path pairs.

Calling a function handler in any plugins:

• 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

Inside the handler, return false to break the loop, return undefined to skip the current item, or return any value to be saved in the result object.

Format value.

Format value by field name.

Read and parse JavaScript file.

Parse JSON string or read and parse JSON file.

Parse YAML text or read and parse YAML file.

Parse YML text or read and parse YML file. Alias for Bajo#fromYaml.

Get download directory. If doesn't exist, it will be created automatically.

Get class method by name.

Get module directory.

Get unit format.

Import file/module from any loaded plugins.

Method proxy from module:Helper.importModule

Import one or more packages belongs to a plugin.

If the last arguments passed is an object, this object serves as options object:

• returnDefault: should return package's default export. Defaults to true
• throwNotFound: should throw if package is not found. Defaults to false
• noCache: always use fresh import. Defaults to false
• asObject: see below. Defaults to false

Return value:

• if options.asObject is true (default false), return as object with package's names as it's keys
• Otherwise depends on how many parameters are provided, it should return the named package or an array of packages

Example: you want to import delay and chalk from bajo plugin because you want to use it in your code `javascript const { importPkg } from this.app.bajo const [delay, chalk] = await importPkg('bajo:delay', 'bajo:chalk')

await delay(1000) ... `

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 human friendly joined array of items.

Get numeric portion and its unit from a string.

Parse input using all registered config handlers. The first handler that returns a valid object or array will be used.

Use this method if you want to parse a text input that can be in any format supported by the registered config handlers.

Read all forms of configuration files from file path.

Internally, it will call Bajo#readConfig twice, first for the default config file and second for the environment based config file. Then it will merge both results using defaultsDeep.

Read and parse file as config object. Supported types: .js, .json and .yml/.yaml. 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

Run named module:Hook.

If no hook found with the given name, it will return an empty array. If a hook has noWait set to true, it will not wait for the hook to finish and will not return its result.

Note: Even though this method returns a result, it is not recommended to use the result for any purpose. Use the result only for debugging or logging purposes. Hooks are designed to be fast, lightweight and mutate arguments given to them so that the next hook can benefit from the changes.

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.

Convert data to JSON string, optionally write to file if options.writeToFile is provided.

Convert object to YAML string, optionally write to file if options.writeToFile is provided.

Convert object to YML string, optionally write to file if options.writeToFile is provided. Alias for Bajo#toYaml.

Supported data types.

Object returned by bajo:getUnitFormat.

Formatter field mapping.

Name in {ns}:{path} format.

Object returned by bajo:breakNsPath().