cafe-utility 4.5.0 → 4.7.1

package/index.d.ts

@@ -31,7 +31,7 @@ declare function ensureDeep(object: CafeObject, path: string, value: unknown): u
 declare function deleteDeep(object: CafeObject, path: string): void;
 declare function replaceDeep(object: CafeObject, path: string, value: unknown): unknown;
 declare function getFirstDeep(object: CafeObject, paths: string[], fallbackToAnyKey: string): unknown;
-declare function forever(callable: () => Promise<void> | (() => void), millis: number): Promise<never>;
+declare function forever(callable: (() => Promise<void>) | (() => void), millis: number): Promise<never>;
 declare function readUtf8FileAsync(path: string): Promise<string>;
 declare function readJsonAsync(path: string): Promise<CafeObject>;
 declare function writeJsonAsync(path: string, object: CafeObject, prettify?: boolean): Promise<void>;
@@ -58,6 +58,7 @@ declare function isString(value: any): value is string;
 declare function isNumber(value: any): value is number;
 declare function isDate(value: any): value is Date;
 declare function isBlank(value: any): boolean;
+declare function isId(value: any): value is number;
 declare function randomLetterString(length: number): string;
 declare function randomAlphanumericString(length: number): string;
 declare function randomRichAsciiString(length: number): string;
@@ -67,11 +68,12 @@ declare function asString(string: any): string;
 declare function asNumber(number: any): number;
 declare function asDate(date: any): Date;
 declare function asNullableString(string: any): string | null;
+declare function asId(value: any): number;
 declare function createLogger(module: string): {
-    trace: (...pieces: string[]) => void;
-    info: (...pieces: string[]) => void;
-    warn: (...pieces: string[]) => void;
-    error: (...pieces: string[]) => void;
+    trace: (...pieces: any[]) => void;
+    info: (...pieces: any[]) => void;
+    warn: (...pieces: any[]) => void;
+    error: (...pieces: any[]) => void;
     errorObject: (error: Error, stackTrace?: boolean) => void;
 };
 declare function enableFileLogging(path: string): void;
@@ -231,7 +233,8 @@ declare function countTruthyValues(object: CafeObject): number;
 declare function flatten(object: CafeObject, arrays?: boolean, prefix?: string): CafeObject | Array<unknown>;
 declare function unflatten(object: CafeObject): CafeObject;
 declare function match(value: string, options: CafeObject<string>, fallback: string): string;
-declare function indexArray<T>(array: T[], keyFn: (item: T) => Indexable, useArrays?: boolean): CafeObject<T | T[]>;
+declare function indexArray<T>(array: T[], keyFn: (item: T) => Indexable): CafeObject<T>;
+declare function indexArrayToCollection<T>(array: T[], keyFn: (item: T) => Indexable): CafeObject<T[]>;
 declare function splitBySize<T>(array: T[], size: number): T[][];
 declare function splitByCount<T>(array: T[], count: number): T[][];
 declare function tokenizeByLength(string: string, length: number): string[];
@@ -280,6 +283,7 @@ export declare const Arrays: {
     splitBySize: typeof splitBySize;
     splitByCount: typeof splitByCount;
     index: typeof indexArray;
+    indexCollection: typeof indexArrayToCollection;
     onlyOrThrow: typeof onlyOrThrow;
     onlyOrNull: typeof onlyOrNull;
     firstOrNull: typeof firstOrNull;
@@ -427,10 +431,12 @@ export declare const Types: {
     isNumber: typeof isNumber;
     isDate: typeof isDate;
     isBlank: typeof isBlank;
+    isId: typeof isId;
     asString: typeof asString;
     asNumber: typeof asNumber;
     asDate: typeof asDate;
     asNullableString: typeof asNullableString;
+    asId: typeof asId;
 };
 export declare const Strings: {
     tokenizeByCount: typeof tokenizeByCount;

package/index.js

@@ -381,6 +381,10 @@ function isBlank(value) {
     return !isString(value) || value.trim().length === 0
 }
 
+function isId(value) {
+    return Number.isInteger(value) && value >= 1
+}
+
 const alphabet = 'abcdefghijklmnopqrstuvwxyz'
 const alphanumericAlphabet = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890'
 const richAsciiAlphabet = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890!@#$%^&*()_+-=[]{}|;:<>?,./'
@@ -454,6 +458,13 @@ function asNullableString(string) {
     return string
 }
 
+function asId(value) {
+    if (!isId(value)) {
+        throw new TypeError('Expected id, got: ' + value)
+    }
+    return value
+}
+
 function represent(value) {
     if (isObject(value)) {
         return JSON.stringify(value, null, 4)
@@ -1477,18 +1488,23 @@ function match(value, options, fallback) {
     return options[value] ? options[value] : fallback
 }
 
-function indexArray(array, keyFn, useArrays) {
+function indexArray(array, keyFn) {
     const target = {}
     for (const element of array) {
         const key = keyFn(element)
-        if (useArrays) {
-            if (!target[key]) {
-                target[key] = []
-            }
-            target[key].push(element)
-        } else {
-            target[key] = element
+        target[key] = element
+    }
+    return target
+}
+
+function indexArrayToCollection(array, keyFn) {
+    const target = {}
+    for (const element of array) {
+        const key = keyFn(element)
+        if (!target[key]) {
+            target[key] = []
         }
+        target[key].push(element)
     }
     return target
 }
@@ -1525,7 +1541,7 @@ function tokenizeByCount(string, count) {
 }
 
 function makeUnique(array, fn) {
-    return Object.values(indexArray(array, fn, false))
+    return Object.values(indexArray(array, fn))
 }
 
 function countUnique(array, mapper, plain, sort, reverse) {
@@ -1678,6 +1694,7 @@ exports.Arrays = {
     splitBySize,
     splitByCount,
     index: indexArray,
+    indexCollection: indexArrayToCollection,
     onlyOrThrow,
     onlyOrNull,
     firstOrNull,
@@ -1831,10 +1848,12 @@ exports.Types = {
     isNumber,
     isDate,
     isBlank,
+    isId,
     asString,
     asNumber,
     asDate,
-    asNullableString
+    asNullableString,
+    asId
 }
 
 exports.Strings = {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "cafe-utility",
-    "version": "4.5.0",
+    "version": "4.7.1",
     "description": "",
     "main": "index.js",
     "exports": {