ve

ve

The root namespace for all Vercengen classes and options.

Source:

Classes

BIUF

Namespaces

Class
Component
Feature

Methods

(static) getFilesInFolder(arg0_folder_path, arg1_evaluated_set) → {Array.<string>}

Returns all non-evaluated files in a folder, so long as an evaluated set is provided.

Source:
Parameters:
Name Type Description
arg0_folder_path string
arg1_evaluated_set Set.<string>
Returns:
Type:
Array.<string>

(static) getImportFiles(patterns) → {Array.<string>}

Returns an Array from a list of patterns. The last pattern to match a file determines its final position in the load order. This function iterates patterns in reverse to ensure that more specific patterns listed later correctly claim files from broader patterns listed earlier.

Source:
Parameters:
Name Type Description
patterns Array.<string>

The list of patterns to resolve.
Returns:
Type:
Array.<string>

The final, ordered list of file paths.

(static) getWildcardsInFolder(arg0_folder_path, arg1_wildcard_pattern) → {Array.<string>}

Returns the absolute file paths of all wildcards within a given folder.

Source:
Parameters:
Name Type Description
arg0_folder_path string
arg1_wildcard_pattern string
Returns:
Type:
Array.<string>

(static) initialise()

Initialises Vercengen and associated UF files.

Source:

(static) start()

Initialises a Vercengen app, alongside necessary UF imports.

arg0_options: Object

  • .do_not_import_UF: boolean - Whether to refuse UF imports unrelated to Vercengen startup functions.
  • .load_files: Array<string> - The sequence of files to load. ! should be used as an exclusion prefix, whilst * functions as a wildcard pattern.
  • .is_browser=true: boolean - Whether the imports are for the Browser/Electron. Imports are assumed to be eval/Node.js otherwise.
  • .is_node=false: boolean - Whether the imports are for Node.js. Overridden by .is_browser. Inputs are assumed to be for eval if false.
  • .special_function: function - The function to execute upon startup and Vercengen initialisation.
Source:
Returns:

Array