Class: Bajo

Constructor

new Bajo(app)

Constructor.

Parameters:

Name	Type	Description
`app`	App	App instance. Usefull to call app method inside a plugin.

Source: class/bajo.js, line 79

Members

alias :string

Alias

Type:

string

Source: class/bajo.js, line 92

config :Bajo.TObject

Config object.

Type:

Bajo.TObject

Source: class/bajo.js, line 106
See: config

hooks :Array.<Bajo.THook>

Hooks container.

Type:

Array.<Bajo.THook>

Source: class/bajo.js, line 113

whiteSpace :Array.<string>

White space characters

Type:

Array.<string>

Source: class/bajo.js, line 98

Methods

breakNsPath(name, checkNsopt) → {TNsPathResult}

Break name to its namespace & path infos

Parameters:

Name	Type	Attributes	Default	Description
`name`	TNsPathPairs \| string			Name to break
`checkNs`	boolean	<optional>	true	If `true` (default), namespace will be checked for its validity

Source: class/bajo.js, line 201

Returns:

Type:: TNsPathResult

breakNsPathFromFile(options) → {Object}

Break file path to its namespace & path infos.

Parameters:

Name Type Description

options

Object

Options object

Properties

Name	Type	Attributes	Description
`file`	string	<optional>	File path to break
`dir`	string	<optional>	Base directory to remove from file path
`ns`	string	<optional>	Namespace to use. If not provided, will be extracted from file path
`suffix`	string	<optional>	Suffix to remove from file path
`getType`	boolean	<optional>	Whether to extract type from file path

Source: class/bajo.js, line 155

Returns:

Namespace and path information

Type:: Object

(async) buildCollections(options) → {Array.<Object>}

Method to transform config's array or object into an array of collection.

Parameters:

Name Type Description

options

Object

Options.

Properties

Name	Type	Attributes	Default	Description
`ns`	string	<optional>		Namespace. If not provided, defaults to `bajo`
`handler`	function	<optional>		Handler to call while building the collection item.
`dupChecks`	Array.<string>	<optional>	[]	Array of keys to check for duplicates.
`container`	string			Key used as container name.
`useDefaultName`	boolean	<optional>	true	If true (default) and `name` key is not provided, returned collection will be named `default`.

Source: class/bajo.js, line 261

Fires:

bajo:beforeBuildCollection
bajo:afterBuildCollection

Returns:

The collection

Type:: Array.<Object>

buildNsPath(optionsopt) → {TNsPathPairs}

Build ns/path pairs.

Parameters:

Name Type Attributes Default Description

options

object

{}

Options object

Properties

Name	Type	Attributes	Default	Description
`ns`	string	<optional>	''	Namespace
`subNs`	string	<optional>		Sub namespace
`subSubNs`	string	<optional>		Sub sub namespace
`path`	string	<optional>		Path

Source: class/bajo.js, line 187

Returns:

Ns/path pairs

Type:: TNsPathPairs

(async) callHandler(name, …argsopt) → {any}

Calling any plugin's method by its name:

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

Parameters:

Name	Type	Attributes	Description
`name`	TNsPathPairs \| Object \| function		Method's name, function handler, plain object or plugin instance.
`args`	any	<optional> <repeatable>	One or more arguments passed as parameter to the handler.

Source: class/bajo.js, line 316

Returns:

Returned value.

Type:: any

(async) eachPlugins(handler, optionsopt) → {any}

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

Parameters:

Name Type Attributes Default Description

handler

function

Function handler. Can be an async function. Scoped to the running plugin.

options

string | Object

{}

Options. If a string is provided, it serves as the glob pattern, otherwise:

Properties

Name	Type	Attributes	Default	Description
`glob`	string \| Array.<string>	<optional>		Glob pattern. If provided,
`useBajo`	boolean	<optional>	false	If true, add `bajo` to the running plugins too.
`prefix`	string	<optional>	''	Prepend glob pattern with prefix.
`noUnderscore`	boolean	<optional>	true	If true (default), matched file with name starts with underscore is ignored.
`returnItems`	any	<optional>		If true, each value of returned handler call will be saved as an object with running plugin name as its keys.

Source: class/bajo.js, line 362

Returns:

Type:: any

format(value, typeopt, optionsopt) → {string}

Format value.

Parameters:

Name Type Attributes Default Description

value

any

Value to format.

type

string

Data type to use. See TBajoDataType for acceptable values. If not provided, return the untouched value.

options

Object

{}

Options.

Properties

Name	Type	Attributes	Default	Description
`emptyValue`	string	<optional>	''	Empty value to use if function resulted empty. Defaults to the one from your config.
`withUnit`	boolean	<optional>	true	Return with its unit appended.
`lang`	string	<optional>		Format value according to this language. Defaults to the one you set in config.
`latitude`	string	<optional>		If Bajo Spatial is loaded and data type is a double or float, then format it as latitude in degree, minute, second.
`longitude`	string	<optional>		If Bajo Spatial is loaded and data type is a double or float, then format it as longitude in degree, minute, second.

Source: class/bajo.js, line 462

Returns:

Formatted value.

Type:: string

formatByType(type, value, dataTypeopt, optionsopt) → {Array|string}

Format value by type.

Parameters:

Name Type Attributes Default Description

type

string

Format type. See TBajoFormatType for acceptable values.

value

any

Value to format.

dataType

string

Value's data type. See TBajoDataType for acceptable values.

options

Object

{}

Options.

Properties

Name	Type	Attributes	Default	Description
`withUnit`	boolean	<optional>	true	Return with its unit appended.
`lang`	string	<optional>		Format value according to this language. Defaults to the one you set in config.

Source: class/bajo.js, line 434

Returns:

Return string if withUnit is true. Otherwise is an array of [value, unit, separator].

Type:: Array | string

(async) fromJs(file, optionsopt) → {Object}

Read and parse JavaScript file.

Parameters:

Name	Type	Attributes	Default	Description
`file`	string			File to read and parse.
`options`	Object	<optional>	{}	Options.

Source: class/bajo.js, line 872

Returns:

Parsed JavaScript object.

Type:: Object

fromJson(data, optionsopt) → {Object}

Read and parse JSON string or object.

Parameters:

Name	Type	Attributes	Default	Description
`data`	string			Filename to load from or JSON string to parse.
`options`	Object	<optional>	{}	Options.

Source: class/bajo.js, line 886

Returns:

Parsed JSON object.

Type:: Object

fromYaml(text, options) → {object}

Parse YAML text

Parameters:

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

Source: class/bajo.js, line 899

Returns:

Parsed object

Type:: object

fromYml(text, options) → {object}

Parse YML text. Alias for fromYaml.

Parameters:

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

Source: class/bajo.js, line 913

Returns:

Parsed object

Type:: object

getMethod(name, thrownopt) → {function}

Get class method by name.

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			Name in format `ns:methodName`.
`thrown`	boolean	<optional>	true	If `true` (default), throw exception in case of error.

Source: class/bajo.js, line 517

Returns:

Class method.

Type:: function

getModuleDir(pkgName, withGlobalDiropt) → {string}

Get module directory.

Parameters:

Name	Type	Attributes	Default	Description
`pkgName`	string			Package name to find.
`withGlobalDir`	boolean	<optional>	true	Whether to include the global module directory.

Source: class/bajo.js, line 532

Returns:

Return absolute package directory.

Type:: string

getUnitFormat(optionsopt) → {TBajoFormatResult}

Get unit format.

Parameters:

Name Type Attributes Default Description

options

Object

{}

Options.

Properties

Name	Type	Attributes	Description
`lang`	string	<optional>	Language to use. Defaults to the one you set in config.
`unitSys`	string	<optional>	Unit system to use. Defaults to language's unit system or `metric` if unspecified.

Source: class/bajo.js, line 415

Returns:

Returned value.

Type:: TBajoFormatResult

(async) importModule()

Import file/module from any loaded plugins.

Method proxy from module:Helper.importModule

Source: class/bajo.js, line 556
See: module:Helper.importModule

(async) importPkg(…pkgs) → {Object|Array}

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) ... `

Parameters:

Name	Type	Attributes	Description
`pkgs`	TNsPathPairs	<repeatable>	One or more packages in format `{ns}:{packageName}`.

Source: class/bajo.js, line 587

Returns:

See above.

Type:: Object | Array

(async) init()

Initialization:

Building base config
Building plugins
Collect all config handler
Building extra config
Setup boot order
Boot loaded plugins
Attach exit handlers

Source: class/bajo.js, line 130

isLogInRange(level) → {boolean}

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

Parameters:

Name	Type	Description
`level`	string	Level to check. See TLogLevels for more.

Source: class/bajo.js, line 631

Returns:

Type:: boolean

isValidApp(dir, returnPkgopt) → {boolean|Object}

Check whether directory is a valid Bajo app.

Parameters:

Name	Type	Attributes	Description
`dir`	string		Directory to check.
`returnPkg`	boolean	<optional>	Set `true` to return its package.json content.

Source: class/bajo.js, line 659

Returns:

Type:: boolean | Object

isValidPlugin(dir, returnPkgopt) → {boolean|Object}

Check whether directory is a valid Bajo plugin.

Parameters:

Name	Type	Attributes	Description
`dir`	string		Directory to check.
`returnPkg`	boolean	<optional>	Set `true` to return its package.json content.

Source: class/bajo.js, line 672

Returns:

Type:: boolean | Object

join(array, options) → {string}

Human friendly join array of items.

Parameters:

Name Type Description

array

Array.<any>

Array to join

options

string | Object

If provided and is a string, it will be used as separator.

Properties

Name	Type	Attributes	Default	Description
`separator`	string	<optional>	', '	Separator to use.
`lastSeparator`	string	<optional>	and	Text to use as the last separator.

Source: class/bajo.js, line 687

Returns:

Type:: string

numUnit(valueopt, defUnitopt) → {string}

Return its numeric portion of a value.

Parameters:

Name	Type	Attributes	Default	Description
`value`	string	<optional>	''	Value to get its numeric portion.
`defUnit`	string	<optional>	''	Default unit if value doesn't have one.

Source: class/bajo.js, line 709

Returns:

Type:: string

(async) readAllConfigs(path, optionsopt) → {Object}

Read all config files from path.

Parameters:

Name	Type	Attributes	Default	Description
`path`	string			Base path to start looking config files.
`options`	Object	<optional>	{}	Options.

Source: class/bajo.js, line 976

Returns:

Merged configuration object.

Type:: Object

readAsConfig(input, extsopt, optionsopt) → {Object|Array|null}

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

Parameters:

Name	Type	Attributes	Default	Description
`input`	string			The input string to be processed by the config handlers.
`exts`	Array.<string>	<optional>		Optional array of extensions to filter the config handlers. If provided, only handlers with matching extensions will be used.
`options`	object	<optional>	{}	Options to be passed to the config handlers.

Source: class/bajo.js, line 1058

Returns:

The result from the first successful config handler, or null if none succeed.

Type:: Object | Array | null

(async) readConfig(file, optionsopt) → {Object}

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

Parameters:

Name Type Attributes Default Description

file

string

File to read and parse.

options

Object

{}

Options.

Properties

Name	Type	Attributes	Default	Description
`ignoreError`	boolean	<optional>		Any exception will be silently discarded.
`ns`	string	<optional>		If given, use this as the scope.
`pattern`	string	<optional>		If given and auto detection is on (extension is `.*`), it will be used for instead the default one.
`defValue`	Object	<optional>	{}	Default value to use if value returned empty.
`parserOpts`	Object	<optional>	{}	Parser setting.
`globOpts`	Object	<optional>	{}	fast-glob options.

Source: class/bajo.js, line 733

Returns:

Type:: Object

readJson(file, thrownNotFoundopt) → {Object}

Read and parse json file.

Parameters:

Name	Type	Attributes	Default	Description
`file`	string			File to read.
`thrownNotFound`	boolean	<optional>	false	If `true`, silently ignore if file is not found.

Source: class/bajo.js, line 851

Returns:

Type:: Object

(async) runHook(hookName, …argsopt) → {Array}

Run named hook/event.

Parameters:

Name	Type	Attributes	Description
`hookName`	TNsPathPairs		Name of the hook to run.
`args`	any	<optional> <repeatable>	Argument passed to the hook function.

Source: class/bajo.js, line 1004

Returns:

Array of hook execution results.

Type:: Array

(async) saveAsDownload(file, item, printSavedopt) → {string}

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.

Parameters:

Name	Type	Attributes	Default	Description
`file`	string			File name.
`item`	Object			Item to save.
`printSaved`	boolean	<optional>	true	Print info on screen.

Source: class/bajo.js, line 1038

Returns:

Full file path.

Type:: string

toJson(data, optionsopt) → {string}

Convert data to JSON string.

Parameters:

Name Type Attributes Default Description

data

Object

Data to convert to JSON string.

options

Object

{}

Options.

Properties

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

Source: class/bajo.js, line 927

Returns:

JSON string

Type:: string

toYaml(object, options) → {string}

Convert object to YAML string

Parameters:

Name	Type	Description
`object`	object	Object to be converted
`options`	object	Options object

Source: class/bajo.js, line 944

Returns:

YAML string

Type:: string

toYml(object, options) → {string}

Convert object to YML string. Alias for toYaml.

Parameters:

Name	Type	Description
`object`	object	Object to be converted
`options`	object	Options object

Source: class/bajo.js, line 963

Returns:

YML string

Type:: string

Type Definitions

TDataType

Supported data types.

Type:

Object

Properties

Name	Type	Description
`0`	string	string
`1`	string	float
`2`	string	double
`3`	string	integer
`4`	string	smallint
`5`	string	date
`6`	string	time
`7`	string	datetime
`8`	string	array
`9`	string	object
`10`	string	auto

Source: lib/helper.js, line 736

TFormatResult

Object returned by bajo:getUnitFormat.

Type:

Object

Properties

Name	Type	Description
`unitSys`	string	Unit system.
`format`	Object	Format object.

Source: class/bajo.js, line 48
See: Bajo#getUnitFormat

TFormatType

General format types,

Type:

Object

Properties

Name	Type	Description
`0`	string	speed
`1`	string	distance
`2`	string	area
`3`	string	degree

Source: lib/helper.js, line 755

TNsPathPairs

Name based {ns}:{path} format.

Type:

string

Source: class/bajo.js, line 38
See: TNsPathResult
Bajo#buildNsPath
Bajo#breakNsPath

TNsPathResult

Object returned by bajo:breakNsPath.

Type:

Object

Properties

Name	Type	Attributes	Description
`ns`	string		Namespace
`subNs`	string	<optional>	Sub namespace
`subSubNs`	string	<optional>	Sub of sub namespace
`path`	string		Path without query string or hash
`fullPath`	string		Full path, including query string and hash

Source: class/bajo.js, line 58
See: TNsPathPairs
Bajo#buildNsPath
Bajo#breakNsPath