@lumjs/core 1.30.0 → 1.31.1

package/lib/index.js

@@ -22,6 +22,7 @@ const types = require('./types');
 /**
  * Define properties on an object or function
  * @name module:@lumjs/core.def
+ * @function
  * @see module:@lumjs/core/types.def
  */
 const def = types.def;
@@ -29,6 +30,7 @@ const def = types.def;
 /**
  * Define *lazy* properties on an object or function
  * @alias module:@lumjs/core.lazy
+ * @function
  * @see module:@lumjs/core/types.lazy
  */
 const lazy = types.lazy;
@@ -37,6 +39,9 @@ def(exports, 'types', types);
 def(exports, 'def',   def);
 def(exports, 'lazy',  lazy);
 
+// TODO: document
+def(exports, 'state', require('./state'));
+
 /**
  * Array utility functions «Lazy»
  * @name module:@lumjs/core.arrays
@@ -80,7 +85,7 @@ lazy(exports, 'flags', () => require('./flags'));
 lazy(exports, 'obj', () => require('./obj'));
 
 /**
- * A wrapper around the Javascript console.
+ * A wrapper around the Javascript console «Lazy»
  * @name module:@lumjs/core.console
  * @type {module:@lumjs/core/console}
  */
@@ -138,7 +143,20 @@ from(require('./objectid'));
  * @see module:@lumjs/core/meta.NYI
  */
 
-// TODO: documentation for 'deprecated' and 'wrapDepr'
+/**
+ * A function indicating that something is deprecated
+ * @name module:@lumjs/core.deprecated
+ * @function
+ * @see module:@lumjs/core/meta.deprecated
+ */
+
+/**
+ * Assign a getter property to an object that calls the `deprecated`
+ * function with a specific message before returning the proxied value.
+ * @name module:@lumjs/core.wrapDepr
+ * @function
+ * @see module:@lumjs/core/meta.wrapDepre
+ */
 
 // These are exported directly, but a meta sub-module also exists.
 // Unlike most sub-modules there is no `meta` property in the main library.
@@ -165,3 +183,9 @@ lazy(exports, 'Enum', () => require('./enum'));
  */
 lazy(exports, 'observable', () => require('./observable'));
 
+/**
+ * The Events module «Lazy»
+ * @name module:@lumjs/core.events
+ * @see module:@lumjs/core/events
+ */
+lazy(exports, 'events', () => require('./events'));

package/lib/meta.js

@@ -1,4 +1,12 @@
 "use strict";
+/**
+ * Meta-programming helpers
+ * 
+ * All of the function exported by this module are also available
+ * in the main {@link module:@lumjs/core core object} itself.
+ * 
+ * @module @lumjs/core/meta
+ */
 
 const {F} = require('./types/js');
 
@@ -13,7 +21,7 @@ const {F} = require('./types/js');
  * @param {string} [msg] - A message for the Error object.
  *
  * @returns {string[]} An array of stack strings.
- * @alias module:@lumjs/core.stacktrace
+ * @alias module:@lumjs/core/meta.stacktrace
  */
 function stacktrace(msg)
 {
@@ -50,7 +58,7 @@ exports.stacktrace = stacktrace;
  * }
  * ```
  * 
- * @alias module:@lumjs/core.AbstractError
+ * @alias module:@lumjs/core/meta.AbstractError
  */
 class AbstractError extends Error
 {
@@ -82,8 +90,7 @@ exports.AbstractError = AbstractError;
 
 /**
  * Function prototypes for async, generator, and async generator functions.
- * @namespace
- * @alias module:@lumjs/core.Functions
+ * @alias module:@lumjs/core/meta.Functions
  */
 const Functions =
 {
@@ -114,7 +121,7 @@ exports.Functions = Functions;
  * @param {string} [prefix=''] A prefix for the error message.
  * 
  * @returns {void}
- * @alias module:@lumjs/core.NYI
+ * @alias module:@lumjs/core/meta.NYI
  */
 function NYI(fatal=true, prefix='') 
 { 
@@ -134,7 +141,7 @@ exports.NYI = NYI;
  * @param {(string|string[])} [rep] Replacement suggestion(s).
  * @param {*} [ret] Value to return
  * @returns {mixed} `ret`
- * @alias module:@lumjs/core.deprecated
+ * @alias module:@lumjs/core/meta.deprecated
  */
 function deprecated(dep, rep, ret)
 {
@@ -167,6 +174,8 @@ exports.deprecated = deprecated;
  * @param {object} [spec.opts] Options for `def()` to add getter with.
  * 
  * @returns {object} `obj`
+ * 
+ * @alias module:@lumjs/core/meta.wrapDepr
  */
 function wrapDepr(obj,prop,spec)
 {

package/lib/obj/copyprops.js

@@ -406,7 +406,7 @@ copyProps.from = function(...sources)
   return ((new $CopyProps()).from(...sources));
 }
 
-const CPC = copyProps.cache =
+copyProps.cache =
 {
   into(target)
   {