@skmtc/core 0.0.333 → 0.0.334

package/script/typescript/List.js

@@ -32,29 +32,75 @@ class List {
             .with('square', () => `[${joined}]`)
             .with('curly', () => `{${joined}}`)
             .with('round', () => `(${joined})`)
+            .with('angle', () => `<${joined}>`)
             .with('none', () => joined)
             .exhaustive();
     }
 }
 exports.List = List;
+/**
+ * Create an empty List that will render as an empty string ''
+ * @returns List
+ */
 Object.defineProperty(List, "toEmpty", {
     enumerable: true,
     configurable: true,
     writable: true,
     value: () => new List([], { bookends: 'none' })
 });
+/**
+ * Create a List with a single value that will render as `value`
+ * @param value
+ * @returns List
+ */
 Object.defineProperty(List, "toSingle", {
     enumerable: true,
     configurable: true,
     writable: true,
-    value: (value) => new List([value], { bookends: 'none' })
+    value: (value) => {
+        return new List([value], { bookends: 'none' });
+    }
 });
-Object.defineProperty(List, "toOptional", {
+/**
+ * If condition is true, return a List with a single value that will render as `value`.
+ * Otherwise, return an empty List that will render as an empty string ''.
+ *
+ * Useful for conditional rendering. For example, rendering a function arg object when
+ * it has at least one property.
+ * @param value
+ * @param condition
+ * @returns List
+ */
+Object.defineProperty(List, "toConditional", {
     enumerable: true,
     configurable: true,
     writable: true,
-    value: (value, condition) => new List([condition ? value : undefined])
+    value: (value, condition) => {
+        return new List([condition ? value : undefined], { bookends: 'none' });
+    }
 });
+/**
+ * Create a record with Stringable values. KeyValue pairs will be joined with `: ` as separator
+ * and the resulting List will be wrapped with `{}`
+ * @param record
+ * @returns `record` with `Stringable` values
+ */
+Object.defineProperty(List, "toRecord", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: (record) => {
+        const entries = Object.entries(record).map(([key, value]) => {
+            return List.toKeyValue(key, value);
+        });
+        return List.toObject(entries);
+    }
+});
+/**
+ * Create a record with `undefined` or empty array or List values filtered out.
+ * @param record
+ * @returns `record` with `undefined` values filtered out
+ */
 Object.defineProperty(List, "toFilteredRecord", {
     enumerable: true,
     configurable: true,
@@ -66,24 +112,52 @@ Object.defineProperty(List, "toFilteredRecord", {
         return List.toObject(entries);
     }
 });
+/**
+ * Join `key` and `value` using `: ` as separator
+ * @param key
+ * @param value
+ * @returns `key` and `value` joined with `: ` as separator
+ */
 Object.defineProperty(List, "toKeyValue", {
     enumerable: true,
     configurable: true,
     writable: true,
-    value: (key, value) => new List([key, value], { separator: ': ' })
+    value: (key, value) => {
+        return new List([key, value], { separator: ': ' });
+    }
 });
+/**
+ * Join `key` and `value` using `.` as separator
+ * @param key
+ * @param value
+ * @returns `key` and `value` joined with `.` as separator
+ */
 Object.defineProperty(List, "toObjectKey", {
     enumerable: true,
     configurable: true,
     writable: true,
-    value: (key, value) => new List([key, value], { separator: '.' })
+    value: (key, value) => {
+        return new List([key, value], { separator: '.' });
+    }
 });
+/**
+ * Join `values` using `, ` as separator and wrap in `{` and `}`
+ * @param values
+ * @returns `values` joined with `, ` as separator and wrapped in `{` and `}`
+ */
 Object.defineProperty(List, "toObject", {
     enumerable: true,
     configurable: true,
     writable: true,
-    value: (values) => new List(values, { bookends: 'curly' })
+    value: (values) => {
+        return new List(values, { bookends: 'curly' });
+    }
 });
+/**
+ * Create a List using the keys of a record
+ * @param record
+ * @returns List of record keys
+ */
 Object.defineProperty(List, "fromRecord", {
     enumerable: true,
     configurable: true,
@@ -92,6 +166,15 @@ Object.defineProperty(List, "fromRecord", {
         return new List(Object.keys(record ?? {}));
     }
 });
+/**
+ * Create a keyValue pair if `value` is not undefined and is not an empty array or List.
+ * Return `undefined` otherwise.
+ *
+ * Useful for filtering out `undefined values from a record.
+ * @param key
+ * @param value
+ * @returns `key` and `value` joined with `: ` as separator if `value` is not undefined and is not an empty array or List. `undefined` otherwise.
+ */
 Object.defineProperty(List, "toFilteredKeyValue", {
     enumerable: true,
     configurable: true,
@@ -100,6 +183,11 @@ Object.defineProperty(List, "toFilteredKeyValue", {
         return List.hasValue(value) ? List.toKeyValue(key, value) : undefined;
     }
 });
+/**
+ * Check if `value` is not undefined and is not an empty array or List.
+ * @param value
+ * @returns `true` if `value` is not undefined and is not an empty array or List. `false` otherwise.
+ */
 Object.defineProperty(List, "hasValue", {
     enumerable: true,
     configurable: true,