Module: createMessage

Methods

(inner) createMessage(templateString, replacements, markeropt) → {string}

Creates a message using a template strings.

Parameters:
NameTypeAttributesDescription
templateStringstring

The template message string.

replacementsArray.<string>

The template string replacements.

markerstring<optional>

The template marker to replace in the string.

Source:
Requires:
Throws:

Will throw an error a message replacement contains a template marker.

Returns:

The message with the template markers replaced.

Type
string

(inner) createMessage(message) → {HTMLElement}

This function creates an HTML 'Message-Box' Element containing a program message.

Parameters:
NameTypeDescription
messagestring | messageBoxObject

A string message to use or an object describing the message.

Source:
Requires:
Returns:
Type
HTMLElement

Methods

(inner) createMessage(templateString, replacements, markeropt) → {string}

Creates a message using a template strings.

Parameters:
NameTypeAttributesDescription
templateStringstring

The template message string.

replacementsArray.<string>

The template string replacements.

markerstring<optional>

The template marker to replace in the string.

Source:
Requires:
Throws:

Will throw an error a message replacement contains a template marker.

Returns:

The message with the template markers replaced.

Type
string

(inner) createMessage(message) → {HTMLElement}

This function creates an HTML 'Message-Box' Element containing a program message.

Parameters:
NameTypeDescription
messagestring | messageBoxObject

A string message to use or an object describing the message.

Source:
Requires:
Returns:
Type
HTMLElement