cafe-utility 4.6.0 → 4.7.2

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,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,15 +68,16 @@ 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;
-    errorObject: (error: Error, stackTrace?: boolean) => void;
+    trace: (...pieces: any[]) => void;
+    info: (...pieces: any[]) => void;
+    warn: (...pieces: any[]) => void;
+    error: (...pieces: any[]) => 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>;
@@ -429,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)
@@ -1837,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.6.0",
+    "version": "4.7.2",
     "description": "",
     "main": "index.js",
     "exports": {