ve

ve

The root namespace for all Vercengen classes and options.

Source:

Namespaces

Class
Component
Feature
Theme

Methods

(static) clear()

Clears all Vercengen components from both state and DOM.

Source:

(static) gc()

Performs garbage collection when elements are detached.

Source:

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

Returns all non-evaluated files in a folder, so long as an evaluated set is provided. /** Recursively collects files in a folder adhering to exclusion options.

Source:
Parameters:
Name Type Attributes Description
arg0_folder_path string
arg1_evaluated_set Set.<string> <optional>
arg2_options Object <optional>
Name Type Attributes Default Description
all_extensions boolean <optional>
 false

Whether to include all files instead of just code/style assets.
ignored_directories Array.<string> <optional>

Directory names to skip.
ignored_directory_substrings Array.<string> <optional>

Substrings of directory names to skip.
ignored_file_substrings Array.<string> <optional>

Substrings of file names to skip (e.g. ['worker']).
Returns:
Type:
Array.<string>

(static) getImportFiles(arg0_patterns, arg1_optionsopt) → {Array.<string>}

Returns a string[] 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 Attributes Description
arg0_patterns Array.<string>

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

The final, ordered list of file paths.

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

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

Source:
Parameters:
Name Type Attributes Description
arg0_folder_path string
arg1_wildcard_pattern string
arg2_options Object <optional>
Returns:
Type:
Array.<string>

(static) initialise()

Initialises Vercengen and associated UF files.

Source:

(static) initialiseIPC(arg0_optionsopt)

Initialises IPC handlers.

List of valid IPC channels:

  • electron:close-dev-tools
  • electron:is-dev-tools-focused
  • electron:is-dev-tools-open
  • electron:open-dev-tools
  • electron:toggle-dev-tools
  • ndjson - NDJSON handler (arg0_function_key, argn_arguments).
  • ndjson:get-all-functions - Returns all NDJSON functions.
  • ontology:initialise - Initialises Ontology streaming.
  • ontology:stream-batch - DB sends batch to render.
  • ontology:stream-done - Marks all streaming as finished (loaded into memory).
  • ontology:stream-next - Render requests batch from DB.
Source:
Parameters:
Name Type Attributes Description
arg0_options Object <optional>
Name Type Attributes Default Description
ontology_stream_size number <optional>
 256

The stream packet size for Ontologies from DB.

(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.
  • .ontology_function: function(arg0_ontologies:Array<Ontology>) - The function to execute once Ontology instances are loaded from DBs.
  • .special_function: function - The function to execute upon startup and Vercengen initialisation.
Source:
Returns:

Array