Module: Helper

Methods

(async, static) addItem(optionsopt)

Add an item to the container

Parameters:

Name Type Attributes Default Description

options

Object

{}

Options for adding an item

Properties

Name	Type	Attributes	Description
`file`	string	<optional>	File path of the item
`container`	Object	<optional>	Container to store the item
`prefix`	string	<optional>	Prefix for the item key

Source: lib/helper.js, line 318

(static) alert(text, message, optsopt) → {string}

Print warning message in page

Parameters:

Name	Type	Attributes	Default
`text`	string
`message`	string
`opts`	Object	<optional>	{}

Source: lib/build-page.js, line 13

Returns:

Type:: string

(async, static) applyConcatRsc(options) → {Promise.<void>}

Apply concatenation of resources (CSS, JS) based on configuration and cache results

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Description
`$`	Object	Cheerio instance
`req`	Object	Request object
`tag`	string	HTML tag
`attr`	string	Attribute name
`type`	string	Resource type

Source: lib/build-page.js, line 280

Returns:

Type:: Promise.<void>

(static) applyInclude($) → {string}

Apply include directive in the page

Parameters:

Name	Type	Description
`$`	Object	Cheerio instance

Source: lib/build-page.js, line 98

Returns:

Type:: string

(async, static) attrsMutation(options)

Mutate attributes of an element and its children

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Description
`$`	Object	Cheerio instance
`el`	Object	Cheerio element
`req`	Object	Request object

Source: lib/build-page.js, line 207

(async, static) buildPage(options) → {Promise.<string>}

Build the final HTML page by processing the template, applying themes, iconsets, and manipulating the DOM as needed

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Description
`text`	string	HTML content
`locals`	Object	Local variables
`opts`	Object	Options

Source: lib/build-page.js, line 363

Returns:

Type:: Promise.<string>

(async, static) buildTheme(mod, fw)

Build a theme

Parameters:

Name	Type	Description
`mod`	Object	Module object
`fw`	Object	Framework object

Source: lib/helper.js, line 361

(async, static) collectInline(type, optionsopt) → {Promise.<Array>}

Collect inline resources (css, scripts) from theme/iconset and options

Parameters:

Name	Type	Attributes	Default	Description
`type`	string			Type of resource ('inlineCss', 'inlineScript')
`options`	Object	<optional>	{}	Additional options for resource collection

Source: lib/helper.js, line 107

Returns:

Array of collected inline resources

Type:: Promise.<Array>

(async, static) collectRegular(type, transformer, optionsopt) → {Promise.<Array>}

Collect regular resources (css, scripts, links) from theme/iconset, frontmatter, and options

Parameters:

Name	Type	Attributes	Default	Description
`type`	string			Type of resource ('css', 'scripts', 'links')
`transformer`	function			Function to transform each resource item
`options`	Object	<optional>	{}	Additional options for resource collection

Source: lib/helper.js, line 57

Returns:

Array of collected and transformed resource items

Type:: Promise.<Array>

(async, static) concatResources(options) → {Promise.<void>}

Concatenate resources (CSS, JS) based on configuration and cache results

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Description
`$`	Object	Cheerio instance
`req`	Object	Request object

Source: lib/build-page.js, line 343

Returns:

Type:: Promise.<void>

(async, static) exports.collectIconsets() → {Promise.<void>}

Collect iconsets

Source: lib/helper.js, line 476

Returns:

Type:: Promise.<void>

(async, static) exports.collectThemes() → {Promise.<void>}

Collect themes

Source: lib/helper.js, line 393

Returns:

Type:: Promise.<void>

(async, static) exports.collectViewEngines() → {Promise.<void>}

Collect view engines

Source: lib/helper.js, line 446

Returns:

Type:: Promise.<void>

(async, static) exports.injectElements(optionsopt)

Inject elements into the page

Parameters:

Name Type Attributes Default Description

options

Object

{}

Options for element injection

Properties

Name	Type	Attributes	Description
`$`	Object	<optional>	Cheerio instance for DOM-like manipulation
`req`	Object	<optional>	Request object
`cmp`	Object	<optional>	Component instance
`reply`	Object	<optional>	Reply object

Source: lib/helper.js, line 266

(static) exports.printLink(link) → {string}

Print a link element

Parameters:

Name	Type	Description
`link`	Object	Link object

Source: lib/helper.js, line 23

Returns:

HTML string for the link element

Type:: string

(static) exports.printScript(script) → {string}

Print a script element

Parameters:

Name	Type	Description
`script`	Object	Script object

Source: lib/helper.js, line 39

Returns:

HTML string for the script element

Type:: string

(async, static) injectCss(optionsopt)

Inject CSS into the page

Parameters:

Name Type Attributes Default Description

options

Object

{}

Options for CSS injection

Properties

Name	Type	Attributes	Description
`$`	Object	<optional>	Cheerio instance for DOM-like manipulation

Source: lib/helper.js, line 233

(async, static) injectLink(optionsopt)

Inject link elements into the page

Parameters:

Name Type Attributes Default Description

options

Object

{}

Options for link injection

Properties

Name	Type	Attributes	Description
`$`	Object	<optional>	Cheerio instance for DOM-like manipulation

Source: lib/helper.js, line 249

(async, static) injectMeta(optionsopt)

Inject meta tags into the page

Parameters:

Name Type Attributes Default Description

options

Object

{}

Options for meta injection

Properties

Name	Type	Attributes	Description
`$`	Object	<optional>	Cheerio instance for DOM-like manipulation
`theme`	Object	<optional>	Theme instance
`req`	Object	<optional>	Request object
`locals`	Object	<optional>	Local variables for rendering

Source: lib/helper.js, line 167

(async, static) injectScript(optionsopt)

Inject scripts into the page

Parameters:

Name Type Attributes Default Description

options

Object

{}

Options for script injection

Properties

Name	Type	Attributes	Description
`$`	Object	<optional>	Cheerio instance for DOM manipulation
`cmp`	Object	<optional>	Component instance
`locals`	Object	<optional>	Local variables for rendering

Source: lib/helper.js, line 144

(async, static) loadItems(type, theme)

Load items into the theme

Parameters:

Name	Type	Description
`type`	string	Type of items to load
`theme`	Object	Theme object to load items into

Source: lib/helper.js, line 335

(async, static) manipulation(options)

Manipulate the DOM based on specific attributes and move elements as needed

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Description
`$`	Object	Cheerio instance
`theme`	Object	Theme object

Source: lib/build-page.js, line 228

(async, static) parseAttr(options)

Parse attributes of an element and apply transformations

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Description
`$`	Object	Cheerio instance
`el`	Object	Cheerio element
`req`	Object	Request object

Source: lib/build-page.js, line 128

(async, static) replace(options) → {Promise.<void>}

Replace unknown component tag with div or comment

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Attributes	Default	Description
`el`	Object			Cheerio element
`cmp`	Object			Component instance
`opts`	Object	<optional>	{}	Options

Source: lib/build-page.js, line 33

Returns:

Type:: Promise.<void>

(async, static) replaceTag(options) → {Promise.<void>}

Replace unknown component tag with div or comment

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Attributes	Default	Description
`el`	Object			Cheerio element
`cmp`	Object			Component instance
`opts`	Object	<optional>	{}	Options

Source: lib/build-page.js, line 77

Returns:

Type:: Promise.<void>