cafe-utility 4.7.1 → 4.8.0

package/index.d.ts

@@ -30,7 +30,7 @@ declare function incrementDeep(object: CafeObject, path: string, amount?: number
 declare function ensureDeep(object: CafeObject, path: string, value: unknown): unknown;
 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 getFirstDeep(object: CafeObject, paths: string[], fallbackToAnyKey?: boolean): unknown;
 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>;
@@ -58,7 +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 isId(value: any): value is number | string;
 declare function randomLetterString(length: number): string;
 declare function randomAlphanumericString(length: number): string;
 declare function randomRichAsciiString(length: number): string;
@@ -69,15 +69,16 @@ 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 asArray(value: any): unknown[];
 declare function createLogger(module: string): {
     trace: (...pieces: any[]) => void;
     info: (...pieces: any[]) => void;
     warn: (...pieces: any[]) => void;
     error: (...pieces: any[]) => void;
-    errorObject: (error: Error, stackTrace?: boolean) => void;
+    errorObject: (error: any, stackTrace?: boolean) => void;
 };
 declare function enableFileLogging(path: string): void;
-declare function expandError(error: string | Error, stackTrace?: boolean): string;
+declare function expandError(error: any, stackTrace?: boolean): string;
 declare function mergeDeep(target: CafeObject, source: CafeObject): CafeObject;
 declare function zip<T>(objects: CafeObject<T>[], reducer: (a: T, b: T) => T): CafeObject<T>;
 declare function zipSum(objects: CafeObject<number>[]): CafeObject<number>;
@@ -437,6 +438,7 @@ export declare const Types: {
     asDate: typeof asDate;
     asNullableString: typeof asNullableString;
     asId: typeof asId;
+    asArray: typeof asArray;
 };
 export declare const Strings: {
     tokenizeByCount: typeof tokenizeByCount;

package/index.js

@@ -382,7 +382,8 @@ function isBlank(value) {
 }
 
 function isId(value) {
-    return Number.isInteger(value) && value >= 1
+    const numeric = typeof value === 'string' ? parseInt(value, 10) : value
+    return Number.isInteger(numeric) && numeric >= 1
 }
 
 const alphabet = 'abcdefghijklmnopqrstuvwxyz'
@@ -462,6 +463,13 @@ function asId(value) {
     if (!isId(value)) {
         throw new TypeError('Expected id, got: ' + value)
     }
+    return typeof value === 'string' ? parseInt(value, 10) : value
+}
+
+function asArray(value) {
+    if (!Array.isArray(value)) {
+        throw new TypeError('Expected array, got: ' + value)
+    }
     return value
 }
 
@@ -1853,7 +1861,8 @@ exports.Types = {
     asNumber,
     asDate,
     asNullableString,
-    asId
+    asId,
+    asArray
 }
 
 exports.Strings = {

package/package.json

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