Class: WaibuMpa

Constructor

new WaibuMpa()

Constructor

Source: index.js, line 43

Members

config

Properties

Type	Description
TConfig	Configuration object

Source: index.js, line 67

configDev

Properties

Type	Description
TConfigDev	Development configuration object

Source: index.js, line 72

configProd

Properties

Type	Description
TConfigProd	Production configuration object

Source: index.js, line 76

htmlTags :Array.<string>

All supported HTML tags

Type:

Array.<string>

Source: index.js, line 49

iconsetMappings :Object

Iconset mappings

Type:

Object

Source: index.js, line 56

Methods

(async) _addRoutes(options) → {Promise.<void>}

Add routes to the application.

Parameters:

Name Type Description

options

Object

The options for adding routes

Properties

Name	Type	Description
`appPrefix`	string	The application prefix
`prefix`	string	The route prefix
`mods`	Array	The route modules
`appCtx`	Object	The application context
`cfg`	Object	The configuration object

Source: index.js, line 1050

Returns:

Type:: Promise.<void>

(async) _applyFormat(options) → {Promise.<string>}

Apply formatting to the given text based on the options.

Parameters:

Name Type Description

options

Object

The options for formatting

Properties

Name	Type	Attributes	Default	Description
`text`	string			The text to format
`locals`	Object	<optional>	{}	The local variables for the template
`opts`	Object	<optional>	{}	The options for formatting

Source: index.js, line 800

Returns:

The formatted text

Type:: Promise.<string>

(async) _buildRoute(options) → {Promise.<void>}

Build routes based on the provided options.

Parameters:

Name Type Description

options

Object

The options for building routes

Properties

Name	Type	Description
`files`	Array	The route files
`pathPrefix`	string	The path prefix for the routes
`dir`	string	The directory containing route files
`ns`	string	The namespace for the routes
`cfg`	Object	The configuration object
`parent`	Object	The parent route object
`urlPrefix`	string	The URL prefix for the routes
`subRoute`	boolean	Whether the route is a sub-route

Source: index.js, line 969

Returns:

Type:: Promise.<void>

(async) _buildRoutes(prefix) → {Promise.<void>}

Build routes for the application.

Parameters:

Name	Type	Description
`prefix`	string	The route prefix

Source: index.js, line 1075

Returns:

Type:: Promise.<void>

_decorate()

Decorate the request and reply objects with additional properties and methods.

Source: index.js, line 819

(async) _handleError(err, req, reply) → {Promise.<string>}

Handle general errors.

Parameters:

Name	Type	Description
`err`	Error	The error object
`req`	Object	The request object
`reply`	Object	The reply object

Source: index.js, line 905

Returns:

The rendered view

Type:: Promise.<string>

(async) _handleNotFound(err, req, reply) → {Promise.<string>}

Handle not found errors.

Parameters:

Name	Type	Description
`err`	Error	The error object
`req`	Object	The request object
`reply`	Object	The reply object

Source: index.js, line 878

Returns:

The rendered view

Type:: Promise.<string>

(async) _handleSession() → {Promise.<void>}

Handle session setup.

Source: index.js, line 1155

Returns:

Type:: Promise.<void>

(async) _handleSubApp() → {Promise.<void>}

Handle sub-applications.

Source: index.js, line 938

Returns:

Type:: Promise.<void>

(async) _loadResource(mod, item) → {Promise.<Array>}

Load resources for the given module and item.

Parameters:

Name	Type	Description
`mod`	Object	The module object
`item`	string	The item key to load resources for

Source: index.js, line 841

Returns:

The loaded resources

Type:: Promise.<Array>

(async) _trashOldSession() → {Promise.<void>}

Trash old sessions.

Source: index.js, line 1136

Returns:

Type:: Promise.<void>

buildUrl(optionsopt) → {string}

Build a URL based on the provided options.

Parameters:

Name Type Attributes Default Description

options

Object

{}

Options for building the URL

Properties

Name	Type	Attributes	Default	Description
`exclude`	Array.<string>	<optional>	[]	Keys to exclude from the query string
`prefix`	string	<optional>	'?'	Prefix for the query string
`base`	string	<optional>		Base path for the URL
`url`	string	<optional>	''	URL to build upon
`params`	Object	<optional>	{}	Parameters to include in the query string
`prettyUrl`	boolean	<optional>		Whether to use a pretty URL format

Source: index.js, line 104

Returns:

The constructed URL

Type:: string

getAppTitle(req) → {string}

Get the title of the application.

Parameters:

Name	Type	Description
`req`	Object	The request object

Source: index.js, line 155

Returns:

The title of the application

Type:: string

getIconset(name, nameOnlyopt) → {Object|string|undefined}

Get an iconset by name.

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			The name of the iconset
`nameOnly`	boolean	<optional>	false	Whether to return only the name

Source: index.js, line 703

Returns:

The iconset object, name, or undefined if not found

Type:: Object | string | undefined

getMenuPages(menu, pathopt, subPathopt) → {Array}

Get the pages from a menu based on the path and subPath.

Parameters:

Name	Type	Attributes	Description
`menu`	Object		The menu object
`path`	string	<optional>	The path to filter the pages
`subPath`	string \| function	<optional>	The subPath to filter the pages or a function to handle the filtering

Source: index.js, line 593

Returns:

The filtered pages

Type:: Array

getPluginTitle(name, req) → {string}

Get the title of a plugin.

Parameters:

Name	Type	Description
`name`	string	The name of the plugin
`req`	Object	The request object

Source: index.js, line 141

Returns:

The title of the plugin

Type:: string

getResource(name) → {Object}

Get the resource information for a given name.

Parameters:

Name	Type	Description
`name`	string	The name of the resource

Source: index.js, line 167

Returns:

The resource information

Type:: Object

getSessionId(rawCookie, secure) → {string}

Get the session ID from the raw cookie.

Parameters:

Name	Type	Description
`rawCookie`	string	The raw cookie string
`secure`	boolean	Whether the cookie is secure

Source: index.js, line 185

Returns:

The session ID

Type:: string

getTheme(name, nameOnlyopt) → {Object|string|undefined}

Get a theme by name.

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			The name of the theme
`nameOnly`	boolean	<optional>	false	Whether to return only the name

Source: index.js, line 689

Returns:

The theme object, name, or undefined if not found

Type:: Object | string | undefined

getViewEngine(ext) → {Object}

Get the view engine for a given file extension.

Parameters:

Name	Type	Description
`ext`	string	The file extension

Source: index.js, line 197

Returns:

The view engine

Type:: Object

groupAttrs(attribsopt, keysopt, removeEmptyopt) → {Object}

Group attributes by keys.

Parameters:

Name	Type	Attributes	Default	Description
`attribs`	Object	<optional>	{}	The attributes to group
`keys`	Array \| string	<optional>	[]	The keys to group by
`removeEmpty`	boolean	<optional>	true	Whether to remove empty groups

Source: index.js, line 211

Returns:

The grouped attributes

Type:: Object

(async) init()

Initialize the plugin

Source: index.js, line 85

jsonStringify(obj, replaceropt, spaceopt) → {string}

Custom JSON stringify function.

Parameters:

Name	Type	Attributes	Description
`obj`	any		The object to stringify
`replacer`	boolean \| function	<optional>	The replacer function or true for custom handling
`space`	number \| string	<optional>	The space argument for JSON.stringify

Source: index.js, line 280
See: https://github.com/siddharth-sunchu/native-methods/blob/master/JSONStringfy.js

Returns:

The JSON string

Type:: string

minify(text) → {string}

Minify HTML text.

Parameters:

Name	Type	Description
`text`	string	The HTML text to minify

Source: index.js, line 263

Returns:

The minified HTML

Type:: string

paginationLayout(totalItems, itemsPerPageopt, currentPageopt) → {Array}

Generate pagination layout.

Parameters:

Name	Type	Attributes	Description
`totalItems`	number \| Object		The total number of items or an object containing pagination info
`itemsPerPage`	number	<optional>	The number of items per page
`currentPage`	number	<optional>	The current page number

Source: index.js, line 369
See: https://github.com/kyleparisi/pagination-layout/blob/master/pagination-layout-be.js

Returns:

The pagination layout

Type:: Array

parseAttribs(text, optionsopt) → {Object}

Parse attributes from a string or object.

Parameters:

Name Type Attributes Default Description

text

string | Object

The text or object to parse

options

Object

{}

The options for parsing

Properties

Name	Type	Attributes	Default	Description
`delimiter`	string	<optional>	' '	The delimiter for splitting the text
`kvDelimiter`	string	<optional>	'='	The delimiter for key-value pairs
`camelCasedKey`	boolean	<optional>	true	Whether to camelCase the keys
`trimValue`	boolean	<optional>	true	Whether to trim the values

Source: index.js, line 619

Returns:

The parsed attributes

Type:: Object

(async) render(tpl, localsopt, optsopt) → {Promise.<string>}

Render a template using the appropriate view engine.

Parameters:

Name	Type	Attributes	Default	Description
`tpl`	string			The template file path
`locals`	Object	<optional>	{}	The local variables for the template
`opts`	Object	<optional>	{}	The options for rendering

Source: index.js, line 516

Returns:

The rendered template

Type:: Promise.<string>

(async) renderString(text, localsopt, optsopt) → {Promise.<string>}

Render a string using the appropriate view engine.

Parameters:

Name	Type	Attributes	Default	Description
`text`	string			The string to render
`locals`	Object	<optional>	{}	The local variables for the template
`opts`	Object	<optional>	{}	The options for rendering

Source: index.js, line 501

Returns:

The rendered string

Type:: Promise.<string>

(async) renderView(options) → {Promise.<string>}

Render a view with the given options.

Parameters:

Name Type Description

options

Object

The options for rendering the view

Properties

Name	Type	Attributes	Default	Description
`tpl`	string			The template to render
`params`	Object	<optional>	{}	The parameters for the template
`opts`	Object	<optional>	{}	The options for rendering
`reply`	Object			The reply object

Source: index.js, line 721

Returns:

The rendered view

Type:: Promise.<string>

stringifyAttribs(obj, kebabCasedKeyopt) → {string}

Stringify attributes from an object.

Parameters:

Name	Type	Attributes	Default	Description
`obj`	Object			The object to stringify
`kebabCasedKey`	boolean	<optional>	true	Whether to kebab-case the keys

Source: index.js, line 655

Returns:

The stringified attributes

Type:: string

stripHtmlTags(html, optionsopt) → {string}

Strip HTML tags from a string.

Parameters:

Name	Type	Attributes	Default	Description
`html`	string			The HTML string to strip
`options`	Object	<optional>	{}	The options for stripping

Source: index.js, line 532

Returns:

The stripped string

Type:: string

urlToBreadcrumb(url, optionsopt) → {Array}

Convert a URL to a breadcrumb array.

Parameters:

Name Type Attributes Default Description

url

string

The URL to convert

options

Object

{}

The options for conversion

Properties

Name	Type	Attributes	Default	Description
`base`	string	<optional>	''	The base URL to remove
`delimiter`	string	<optional>	'/'	The delimiter for splitting the URL
`returnParts`	boolean	<optional>	false	Whether to return the parts array
`handler`	function	<optional>		The handler function for each breadcrumb
`handlerScope`	Object	<optional>		The scope for the handler function
`handlerOpts`	Object	<optional>	{}	The options for the handler function

Source: index.js, line 551

Returns:

The breadcrumb array

Type:: Array