@skmtc/core 0.0.798 → 0.0.800

package/script/typescript/List.js

@@ -139,6 +139,14 @@ class List {
         this.bookends = bookends ?? 'none';
         this.skipEmpty = skipEmpty ?? false;
     }
+    /**
+     * Converts the list to its string representation.
+     *
+     * Joins all values with the configured separator and wraps with bookends.
+     * Returns empty string if skipEmpty is enabled and list is empty.
+     *
+     * @returns Formatted string representation of the list
+     */
     toString() {
         if (this.skipEmpty && this.values.length === 0) {
             return '';
@@ -381,8 +389,20 @@ Object.defineProperty(List, "hasValue", {
         return true;
     }
 });
+/**
+ * Utility class for working with arrays of string keys.
+ *
+ * Provides methods for transforming key arrays into objects and lists
+ * with custom mapping functions.
+ */
 class KeyList {
+    /**
+     * Creates a new KeyList instance.
+     *
+     * @param keys - Array of string keys to work with
+     */
     constructor(keys) {
+        /** Array of string keys */
         Object.defineProperty(this, "keys", {
             enumerable: true,
             configurable: true,
@@ -391,15 +411,38 @@ class KeyList {
         });
         this.keys = keys;
     }
+    /**
+     * Transforms keys into an object using a mapping function.
+     *
+     * @param mapFn - Function to transform each key into a value
+     * @param options - Options for handling empty values
+     * @returns Object with keys mapped to transformed values
+     */
     toObject(mapFn, { skipEmpty } = {}) {
         return List.toObject(this.keys.map((key, index) => mapFn(key, index)), { skipEmpty });
     }
+    /**
+     * Creates a plain object with keys as both keys and values.
+     *
+     * @returns Object where each key maps to itself
+     */
     toObjectPlain() {
         return List.toObject(this.keys);
     }
+    /**
+     * Transforms keys into a List using a mapping function.
+     *
+     * @param mapFn - Function to transform each key into a value
+     * @returns List containing the transformed values
+     */
     toLines(mapFn) {
         return List.toLines(this.keys.map((key, index) => mapFn(key, index)));
     }
+    /**
+     * Creates a List with keys as the values.
+     *
+     * @returns List containing the original keys
+     */
     toLinesPlain() {
         return List.toLines(this.keys);
     }