@schukai/monster 1.15.5 → 1.17.1

package/source/dom/customcontrol.js

@@ -27,7 +27,7 @@ const internalSymbol = Symbol('internalSymbol');
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/customcontrol.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/customcontrol.js';
  * console.log(new Monster.DOM.CustomControl())
  * </script>
  * ```
@@ -36,29 +36,36 @@ const internalSymbol = Symbol('internalSymbol');
  *
  * ```
  * <script type="module">
- * import {CustomControl} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/customcontrol.js';
+ * import {CustomControl} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/customcontrol.js';
  * console.log(new CustomControl())
  * </script>
  * ```
  *
+ * @summary A base class for customcontrols
  * @see https://www.npmjs.com/package/element-internals-polyfill
  * @see https://github.com/WICG/webcomponents
  * @see https://html.spec.whatwg.org/multipage/custom-elements.html#custom-elements
  * @since 1.14.0
  * @copyright schukai GmbH
- * @memberOf Monster/DOM
+ * @memberOf Monster.DOM
  */
 class CustomControl extends CustomElement {
 
     /**
+     * IMPORTANT: CustomControls instances are not created via the constructor, but either via a tag in the HTML or via <code>document.createElement()</code>.
      *
      * @throws {Error} the ElementInternals is not supported and a polyfill is necessary
+     * @summary create new Instance
      */
     constructor() {
         super();
 
         if (typeof this['attachInternals'] === 'function') {
-            // currently only supported by chrome
+            /**
+             * currently only supported by chrome
+             * @property {Object}
+             * @private
+             */
             this[internalSymbol] = this.attachInternals();
         }
 
@@ -75,10 +82,6 @@ class CustomControl extends CustomElement {
     }
 
     /**
-     * | option         | description                     |
-     * |----------------|---------------------------------|
-     * |                |                                 |
-     *
      * Derived classes can override and extend this method as follows.
      *
      * ```
@@ -284,6 +287,7 @@ class CustomControl extends CustomElement {
  * @private
  * @return {object}
  * @throws {Error} the ElementInternals is not supported and a polyfill is necessary
+ * @this CustomControl
  */
 function getInternal() {
     const self = this;

package/source/dom/customelement.js

@@ -31,15 +31,25 @@ const internalDataSymbol = Symbol.for(PROPERTY_KEY_INTERNALDATA);
 const objectLinkSymbol = Symbol.for(OBJECTLINK_KEY_UPDATER);
 
 /**
+ * @memberOf Monster.DOM
  * @type {symbol}
  */
 const initMethodSymbol = Symbol('initMethodSymbol');
 
 /**
+ * @memberOf Monster.DOM
  * @type {symbol}
  */
 const assembleMethodSymbol = Symbol('assembleMethodSymbol');
 
+
+/**
+ * HTMLElement
+ * @external HTMLElement
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement
+ */
+
+
 /**
  * To define a new HTML element we need the power of CustomElement
  *
@@ -50,7 +60,7 @@ const assembleMethodSymbol = Symbol('assembleMethodSymbol');
  *
  * ```
  * <script type="module">
- * import {CustomElement} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/customelement.js';
+ * import {CustomElement} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/customelement.js';
  * console.log(new Monster.DOM.CustomElement())
  * </script>
  * ```
@@ -59,7 +69,7 @@ const assembleMethodSymbol = Symbol('assembleMethodSymbol');
  *
  * ```
  * <script type="module">
- * import {CustomElement} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/customelement.js';
+ * import {CustomElement} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/customelement.js';
  * console.log(new CustomElement())
  * </script>
  * ```
@@ -144,7 +154,8 @@ const assembleMethodSymbol = Symbol('assembleMethodSymbol');
  * @see https://html.spec.whatwg.org/multipage/custom-elements.html#custom-elements
  * @since 1.7.0
  * @copyright schukai GmbH
- * @memberOf Monster/DOM
+ * @memberOf Monster.DOM
+ * @extends external:HTMLElement
  */
 class CustomElement extends HTMLElement {
 
@@ -173,11 +184,6 @@ class CustomElement extends HTMLElement {
     }
 
     /**
-     * | option         | description                                                                                                                                                                                                                                                                |
-     * |----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-     * | shadowMode     | `open` Elements of the shadow root are accessible from JavaScript outside the root, for example using. `close` Denies access to the node(s) of a closed shadow root from JavaScript outside it                                                                             |
-     * | delegatesFocus | A boolean that, when set to true, specifies behavior that mitigates custom element issues around focusability. When a non-focusable part of the shadow DOM is clicked, the first focusable part is given focus, and the shadow host is given any available :focus styling. |
-     * | templates.main | Main template                                                                                                                                                                                                                                                              |
      *
      * Derived classes can override and extend this method as follows.
      *
@@ -189,6 +195,11 @@ class CustomElement extends HTMLElement {
      * }
      * ```
      *
+     * @property {string} shadowMode=open `open` Elements of the shadow root are accessible from JavaScript outside the root, for example using. `close` Denies access to the node(s) of a closed shadow root from JavaScript outside it
+     * @property {Boolean} delegatesFocus=true A boolean that, when set to true, specifies behavior that mitigates custom element issues around focusability. When a non-focusable part of the shadow DOM is clicked, the first focusable part is given focus, and the shadow host is given any available :focus styling.
+     * @property {Object} templates Templates
+     * @property {string} templates.main=undefined Main template
+     *
      * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/attachShadow
      * @return {{shadowMode: string, delegatesFocus: boolean}}
      * @since 1.8.0
@@ -439,6 +450,7 @@ class CustomElement extends HTMLElement {
 /**
  * @since 1.15.0
  * @private
+ * @this CustomElement
  */
 function initOptionObserver() {
     const self = this;
@@ -520,7 +532,8 @@ function initHtmlContent() {
 /**
  * @private
  * @return {CustomElement}
- * @memberOf Monster/DOM
+ * @memberOf Monster.DOM
+ * @this CustomElement
  * @since 1.16.0
  */
 function initCSSStylesheet() {
@@ -550,7 +563,7 @@ function initCSSStylesheet() {
  * @return {CustomElement}
  * @throws {Error} html is not set.
  * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/attachShadow
- * @memberOf Monster/DOM
+ * @memberOf Monster.DOM
  * @since 1.8.0
  */
 function initShadowRoot() {
@@ -589,7 +602,7 @@ function initShadowRoot() {
  * @return {void}
  * @since 1.7.0
  * @copyright schukai GmbH
- * @memberOf Monster/DOM
+ * @memberOf Monster.DOM
  * @throws {DOMException} Failed to execute 'define' on 'CustomElementRegistry': is not a valid custom element name
  */
 function registerCustomElement(element) {

package/source/dom/events.js

@@ -13,7 +13,7 @@ import {getDocument} from "./util.js";
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/events.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/events.js';
  * console.log(new Monster.DOM.fireEvent())
  * </script>
  * ```
@@ -22,7 +22,7 @@ import {getDocument} from "./util.js";
  *
  * ```
  * <script type="module">
- * import {fireEvent} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/events.js';
+ * import {fireEvent} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/events.js';
  * console.log(fireEvent())
  * </script>
  * ```
@@ -32,7 +32,7 @@ import {getDocument} from "./util.js";
  * @return {void}
  * @since 1.10.0
  * @copyright schukai GmbH
- * @memberOf Monster/DOM
+ * @memberOf Monster.DOM
  * @throws {TypeError} value is not an instance of HTMLElement or HTMLCollection
  */
 function fireEvent(element, type) {
@@ -71,7 +71,7 @@ function fireEvent(element, type) {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/events.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/events.js';
  * console.log(new Monster.DOM.findTargetElementFromEvent())
  * </script>
  * ```
@@ -80,7 +80,7 @@ function fireEvent(element, type) {
  *
  * ```
  * <script type="module">
- * import {findTargetElementFromEvent} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/events.js';
+ * import {findTargetElementFromEvent} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/events.js';
  * console.log(findTargetElementFromEvent())
  * </script>
  * ```
@@ -90,7 +90,7 @@ function fireEvent(element, type) {
  * @param {string} attributeName
  * @param {string|null} attributeValue
  * @throws {Error} unsupported event
- * @memberOf Monster/DOM
+ * @memberOf Monster.DOM
  * @throws {TypeError} value is not a string
  * @throws {TypeError} value is not an instance of HTMLElement
  */

package/source/dom/locale.js

@@ -8,19 +8,20 @@ import {assignToNamespace, Monster} from '../namespace.js';
 import {getDocument} from "./util.js";
 
 /**
+ * @private
  * @type {string}
  */
 const DEFAULT_LANGUAGE = 'en';
 
 /**
  * With this function you can read the language version set by the document.
- * For this the attibute `lang` in the html tag is read. If no attribute is set, `en` is used as default.
+ * For this the attribute `lang` in the html tag is read. If no attribute is set, `en` is used as default.
  *
  * You can call the function via the monster namespace `new Monster.DOM.getLocaleOfDocument()`.
  *
  * ```
  * <script type="module">
- * import {getLocaleOfDocument} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/locale.js';
+ * import {getLocaleOfDocument} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/locale.js';
  * console.log(new Monster.DOM.getLocaleOfDocument())
  * </script>
  * ```
@@ -29,14 +30,14 @@ const DEFAULT_LANGUAGE = 'en';
  *
  * ```
  * <script type="module">
- * import {getLocaleOfDocument} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/locale.js';
+ * import {getLocaleOfDocument} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/locale.js';
  * console.log(new getLocaleOfDocument())
  * </script>
  * ```
  *
  * @since 1.13.0
  * @copyright schukai GmbH
- * @memberOf Monster/DOM
+ * @memberOf Monster.DOM
  * @throws {TypeError} value is not a string
  * @throws {Error} unsupported locale
  */

package/source/dom/namespace.js

@@ -3,7 +3,8 @@
 /**
  * In this namespace you will find classes and methods for handling the DOM.
  *
- * @namespace Monster/DOM
+ * @namespace Monster.DOM
+ * @memberOf Monster
  * @author schukai GmbH
  */
 
@@ -11,4 +12,4 @@
  * @private
  * @type {string}
  */
-const namespace = "Monster.DOM";
+export const namespace = "Monster.DOM";

package/source/dom/template.js

@@ -14,7 +14,7 @@ import {getDocumentTheme} from "./theme.js";
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/template.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/template.js';
  * console.log(new Monster.DOM.Template())
  * </script>
  * ```
@@ -23,14 +23,14 @@ import {getDocumentTheme} from "./theme.js";
  *
  * ```
  * <script type="module">
- * import {Template} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/template.js';
+ * import {Template} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/template.js';
  * console.log(new Template())
  * </script>
  * ```
  *
  * @since 1.6.0
  * @copyright schukai GmbH
- * @memberOf Monster/DOM
+ * @memberOf Monster.DOM
  */
 class Template extends Base {
     /**
@@ -73,7 +73,7 @@ class Template extends Base {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/template.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/template.js';
  * console.log(Monster.DOM.findDocumentTemplate())
  * </script>
  * ```
@@ -82,7 +82,7 @@ class Template extends Base {
  *
  * ```
  * <script type="module">
- * import {findTemplate} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/template.js';
+ * import {findTemplate} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/template.js';
  * console.log(findDocumentTemplate())
  * </script>
  * ```
@@ -92,7 +92,7 @@ class Template extends Base {
  * @return {Template}
  * @since 1.7.0
  * @copyright schukai GmbH
- * @memberOf Monster/DOM
+ * @memberOf Monster.DOM
  * @throws {Error} template id not found.
  * @throws {TypeError} value is not a string
  */

package/source/dom/theme.js

@@ -15,7 +15,7 @@ import {ATTRIBUTE_THEME_NAME, DEFAULT_THEME} from "./constants.js";
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/theme.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/theme.js';
  * console.log(new Monster.DOM.Theme())
  * </script>
  * ```
@@ -24,14 +24,14 @@ import {ATTRIBUTE_THEME_NAME, DEFAULT_THEME} from "./constants.js";
  *
  * ```
  * <script type="module">
- * import {Theme} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/theme.js';
+ * import {Theme} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/theme.js';
  * console.log(new Theme())
  * </script>
  * ```
  *
  * @example
  *
- * import {getDocumentTheme} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/theme.js';
+ * import {getDocumentTheme} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/theme.js';
  *
  * const theme = getDocumentTheme();
  * console.log(theme.getName());
@@ -39,7 +39,7 @@ import {ATTRIBUTE_THEME_NAME, DEFAULT_THEME} from "./constants.js";
  *
  * @since 1.7.0
  * @copyright schukai GmbH
- * @memberOf Monster/DOM
+ * @memberOf Monster.DOM
  */
 class Theme extends Base {
 
@@ -77,6 +77,7 @@ class Theme extends Base {
  * the default theme name is `monster`.
  *
  * @return {Theme}
+ * @memberOf Monster.DOM
  * @since 1.7.0
  */
 function getDocumentTheme() {

package/source/dom/updater.js

@@ -34,7 +34,7 @@ import {getDocument} from "./util.js";
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/updater.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/updater.js';
  * console.log(new Monster.DOM.Updater())
  * </script>
  * ```
@@ -43,14 +43,14 @@ import {getDocument} from "./util.js";
  *
  * ```
  * <script type="module">
- * import {Updater} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/updater.js';
+ * import {Updater} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/updater.js';
  * console.log(new Updater())
  * </script>
  * ```
  *
  * @example
  *
- * import {Updater} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/updater.js';
+ * import {Updater} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/updater.js';
  *
  * // First we prepare the html document.
  * // This is done here via script, but can also be inserted into the document as pure html.
@@ -76,7 +76,7 @@ import {getDocument} from "./util.js";
  *
  * @since 1.8.0
  * @copyright schukai GmbH
- * @memberOf Monster/DOM
+ * @memberOf Monster.DOM
  * @throws {Error} the value is not iterable
  * @throws {Error} pipes are not allowed when cloning a node.
  * @throws {Error} no template was found with the specified key.
@@ -244,7 +244,8 @@ class Updater extends Base {
 /**
  * @private
  * @since 1.9.0
- * @return {function}
+ * @return {function
+ * @this Updater
  */
 function getCheckStateCallback() {
     const self = this;
@@ -275,6 +276,7 @@ const symbol = Symbol('EventHandler');
 /**
  * @private
  * @return {function}
+ * @this Updater
  */
 function getControlEventHandler() {
 
@@ -385,6 +387,7 @@ function removeElement(change) {
  * @throws {Error} pipes are not allowed when cloning a node.
  * @throws {Error} no template was found with the specified key.
  * @throws {Error} the maximum depth for the recursion is reached.
+ * @this Updater
  */
 function insertElement(change) {
     const self = this;
@@ -539,6 +542,7 @@ function applyRecursive(node, key, path) {
  * @since 1.8.0
  * @param {object} change
  * @return {void}
+ * @this Updater
  */
 function updateContent(change) {
     const self = this;
@@ -615,6 +619,7 @@ function updateAttributes(change) {
  * @param {array} parts
  * @param {object} subject
  * @return {void}
+ * @this Updater
  */
 function runUpdateAttributes(container, parts, subject) {
 
@@ -673,6 +678,7 @@ function runUpdateAttributes(container, parts, subject) {
  * @param {string} name
  * @param {string|number|undefined} value
  * @return {void}
+ * @this Updater
  */
 
 function handleInputControlAttributeUpdate(element, name, value) {

package/source/dom/util.js

@@ -13,7 +13,7 @@ import {validateString} from "../types/validate.js";
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/util.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/util.js';
  * console.log(Monster.DOM.getDocument())
  * </script>
  * ```
@@ -22,7 +22,7 @@ import {validateString} from "../types/validate.js";
  *
  * ```
  * <script type="module">
- * import {getDocument} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/util.js';
+ * import {getDocument} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/util.js';
  * console.log(getDocument())
  * </script>
  * ```
@@ -57,7 +57,7 @@ import {validateString} from "../types/validate.js";
  * @returns {object}
  * @since 1.6.0
  * @copyright schukai GmbH
- * @memberOf Monster/DOM
+ * @memberOf Monster.DOM
  * @throws {Error} not supported environment
  */
 function getDocument() {
@@ -74,7 +74,7 @@ function getDocument() {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/util.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/util.js';
  * console.log(Monster.DOM.getWindow())
  * </script>
  * ```
@@ -83,7 +83,7 @@ function getDocument() {
  *
  * ```
  * <script type="module">
- * import {getWindow} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/util.js';
+ * import {getWindow} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/util.js';
  * console.log(getWindow(null))
  * </script>
  * ```
@@ -120,7 +120,7 @@ function getDocument() {
  * @returns {object}
  * @since 1.6.0
  * @copyright schukai GmbH
- * @memberOf Monster/DOM
+ * @memberOf Monster.DOM
  * @throws {Error} not supported environment
  */
 function getWindow() {
@@ -140,7 +140,7 @@ function getWindow() {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/util.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/util.js';
  * console.log(Monster.DOM.getDocumentFragmentFromString())
  * </script>
  * ```
@@ -149,7 +149,7 @@ function getWindow() {
  *
  * ```
  * <script type="module">
- * import {getDocumentFragmentFromString} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/dom/util.js';
+ * import {getDocumentFragmentFromString} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/dom/util.js';
  * console.log(getDocumentFragmentFromString('<div></div>'))
  * </script>
  * ```
@@ -184,7 +184,7 @@ function getWindow() {
  * @returns {DocumentFragment}
  * @since 1.6.0
  * @copyright schukai GmbH
- * @memberOf Monster/DOM
+ * @memberOf Monster.DOM
  * @throws {Error} not supported environment
  * @throws {TypeError} value is not a string
  */

package/source/i18n/locale.js

@@ -9,30 +9,32 @@ import {validateString} from "../types/validate.js";
 import {clone} from "../util/clone.js";
 
 /**
+ * @memberOf Monster.I18n
  * @type {symbol}
  */
 const propertiesSymbol = Symbol('properties');
 
 /**
  * @type {symbol}
+ * @memberOf Monster.I18n
  */
 const localeStringSymbol = Symbol('localeString');
 
 /**
- * You can call the method via the monster namespace `new Monster.I18n.Locale()`.
+ * You can create an instance via the monster namespace `new Monster.I18n.Locale()`.
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/i18n/locale.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/i18n/locale.js';
  * console.log(new Monster.I18n.Locale())
  * </script>
  * ```
  *
- * Alternatively, you can also integrate this function individually.
+ * Alternatively, you can also integrate this class individually.
  *
  * ```
  * <script type="module">
- * import {Locale} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/i18n/locale.js';
+ * import {Locale} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/i18n/locale.js';
  * console.log(new Locale())
  * </script>
  * ```
@@ -70,18 +72,18 @@ const localeStringSymbol = Symbol('localeString');
  *
  * @since 1.13.0
  * @copyright schukai GmbH
- * @memberOf Monster/I18n
+ * @memberOf Monster.I18n
  * @see https://datatracker.ietf.org/doc/html/rfc3066
  */
 class Locale extends Base {
 
     /**
-     * @param {string|undefined} language
-     * @param {string|undefined} region
-     * @param {string|undefined} script
-     * @param {string|undefined} variants
-     * @param {string|undefined} extlang
-     * @param {string|undefined} privateUse
+     * @param {string} language
+     * @param {string} [region]
+     * @param {string} [script]
+     * @param {string} [variants]
+     * @param {string} [extlang]
+     * @param {string} [privateUse]
      * @throws {Error} unsupported locale
      */
     constructor(language, region, script, variants, extlang, privateUse) {
@@ -170,7 +172,7 @@ class Locale extends Base {
     }
 
     /**
-     * @return {object}
+     * @return {Monster.I18n.LocaleMap}
      */
     getMap() {
         return clone(this[propertiesSymbol])
@@ -179,6 +181,16 @@ class Locale extends Base {
 
 }
 
+/**
+ * @typedef {Object} LocaleMap
+ * @property {string} language
+ * @property {string} script
+ * @property {string} region
+ * @property {string} variants
+ * @property {string} extlang
+ * @property {string} privateUse
+ * @memberOf Monster.I18n
+ */
 
 /**
  * Parse local according to rfc4646 standard
@@ -189,7 +201,7 @@ class Locale extends Base {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/i18n/locale.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/i18n/locale.js';
  * console.log(new Monster.I18n.createLocale())
  * </script>
  * ```
@@ -198,7 +210,7 @@ class Locale extends Base {
  *
  * ```
  * <script type="module">
- * import {createLocale} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/i18n/locale.js';
+ * import {createLocale} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/i18n/locale.js';
  * console.log(createLocale())
  * </script>
  * ```
@@ -255,7 +267,7 @@ class Locale extends Base {
  * @returns {Locale}
  * @since 1.14.0
  * @copyright schukai GmbH
- * @memberOf Monster/I18n
+ * @memberOf Monster.I18n
  * @throws {TypeError} value is not a string
  * @throws {Error} unsupported locale
  */