@xylabs/object 5.0.83 → 5.0.84

package/dist/neutral/omitBy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"omitBy.d.ts","sourceRoot":"","sources":["../../src/omitBy.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAE7D,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,KAAK,OAAO,CAAA;AA+B3H,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,WAAW,EAC1C,KAAK,CAAC,EACN,WAAW,eAAe,EAC1B,iBAAY,KACX,OAAO,CAAC,CAAC,CAMX,CAAA;AAOD,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,WAAW,EAAE,CAAC,SAAS,MAAM,EAAE,SAAS,CAAC,EAAE,QAAQ,CAAC,EAAE,iBAAc,KAAG,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAEpI,CAAA"}
+{"version":3,"file":"omitBy.d.ts","sourceRoot":"","sources":["../../src/omitBy.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAE7D,sFAAsF;AACtF,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,KAAK,OAAO,CAAA;AA+B3H;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,WAAW,EAC1C,KAAK,CAAC,EACN,WAAW,eAAe,EAC1B,iBAAY,KACX,OAAO,CAAC,CAAC,CAMX,CAAA;AAOD;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,WAAW,EAAE,CAAC,SAAS,MAAM,EAAE,SAAS,CAAC,EAAE,QAAQ,CAAC,EAAE,iBAAc,KAAG,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAEpI,CAAA"}

package/dist/neutral/pickBy.d.ts

@@ -1,6 +1,21 @@
 import type { EmptyObject } from './EmptyObject.ts';
 import type { DeepPickStartsWith } from './PickStartsWith.ts';
+/** A predicate function used to determine which properties to pick from an object. */
 export type PickByPredicate<T extends EmptyObject = Record<string, unknown>> = (value: T[keyof T], key: keyof T) => boolean;
+/**
+ * Creates a new object containing only the properties that satisfy the predicate, with optional recursive depth.
+ * @param obj - The source object to pick properties from.
+ * @param predicate - A function that returns true for properties to include.
+ * @param maxDepth - Maximum recursion depth for nested objects.
+ * @returns A partial copy of the object with only matching properties.
+ */
 export declare const pickBy: <T extends EmptyObject>(obj: T, predicate: PickByPredicate, maxDepth?: number) => Partial<T>;
+/**
+ * Picks all properties whose keys start with the given prefix, recursively through nested objects.
+ * @param payload - The source object.
+ * @param prefix - The string prefix to match keys against.
+ * @param maxDepth - Maximum recursion depth.
+ * @returns A new object containing only properties with matching prefixed keys.
+ */
 export declare const pickByPrefix: <T extends EmptyObject, P extends string>(payload: T, prefix: P, maxDepth?: number) => DeepPickStartsWith<T, P>;
 //# sourceMappingURL=pickBy.d.ts.map

package/dist/neutral/pickBy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pickBy.d.ts","sourceRoot":"","sources":["../../src/pickBy.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAE7D,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,KAAK,OAAO,CAAA;AA+B3H,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,WAAW,EAC1C,KAAK,CAAC,EACN,WAAW,eAAe,EAC1B,iBAAY,KACX,OAAO,CAAC,CAAC,CAMX,CAAA;AAOD,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,WAAW,EAAE,CAAC,SAAS,MAAM,EAAE,SAAS,CAAC,EAAE,QAAQ,CAAC,EAAE,iBAAc,KAAG,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAEpI,CAAA"}
+{"version":3,"file":"pickBy.d.ts","sourceRoot":"","sources":["../../src/pickBy.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAE7D,sFAAsF;AACtF,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,KAAK,OAAO,CAAA;AA+B3H;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,WAAW,EAC1C,KAAK,CAAC,EACN,WAAW,eAAe,EAC1B,iBAAY,KACX,OAAO,CAAC,CAAC,CAMX,CAAA;AAOD;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,WAAW,EAAE,CAAC,SAAS,MAAM,EAAE,SAAS,CAAC,EAAE,QAAQ,CAAC,EAAE,iBAAc,KAAG,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAEpI,CAAA"}

package/dist/neutral/removeFields.d.ts

@@ -1,3 +1,9 @@
 import type { EmptyObject } from './EmptyObject.ts';
+/**
+ * Returns a shallow copy of the object with the specified fields removed.
+ * @param obj - The source object.
+ * @param fields - An array of keys to remove.
+ * @returns A new object without the specified fields.
+ */
 export declare const removeFields: <T extends EmptyObject, K extends keyof T>(obj: T, fields: K[]) => Omit<T, K>;
 //# sourceMappingURL=removeFields.d.ts.map

package/dist/neutral/removeFields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"removeFields.d.ts","sourceRoot":"","sources":["../../src/removeFields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,WAAW,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,KAAK,CAAC,EAAE,QAAQ,CAAC,EAAE,KAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAMrG,CAAA"}
+{"version":3,"file":"removeFields.d.ts","sourceRoot":"","sources":["../../src/removeFields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,WAAW,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,KAAK,CAAC,EAAE,QAAQ,CAAC,EAAE,KAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAMrG,CAAA"}

package/dist/neutral/toSafeJson.d.ts

@@ -1,7 +1,41 @@
 import type { JsonArray, JsonObject, JsonValue } from './JsonObject.ts';
+/**
+ * Converts an array to a JSON-safe array, handling circular references and depth limits.
+ * @param value - The array to convert.
+ * @param cycleList - Tracks visited objects to detect circular references.
+ * @param maxDepth - Maximum recursion depth before truncating.
+ * @returns A JSON-safe array representation.
+ */
 export declare const toSafeJsonArray: (value: unknown[], cycleList?: unknown[], maxDepth?: number) => JsonArray;
+/**
+ * Converts an object to a JSON-safe object, handling circular references and depth limits.
+ * @param value - The object to convert.
+ * @param cycleList - Tracks visited objects to detect circular references.
+ * @param maxDepth - Maximum recursion depth before truncating.
+ * @returns A JSON-safe object representation.
+ */
 export declare const toSafeJsonObject: (value: object, cycleList?: unknown[], maxDepth?: number) => JsonObject;
+/**
+ * Converts an unknown value to a JSON-safe value, replacing circular references with '[Circular]' and
+ * non-JSON types with descriptive placeholder strings.
+ * @param value - The value to convert.
+ * @param cycleList - Tracks visited objects to detect circular references.
+ * @param maxDepth - Maximum recursion depth before truncating with '[MaxDepth]'.
+ * @returns A JSON-safe representation of the value.
+ */
 export declare const toSafeJsonValue: (value: unknown, cycleList?: unknown[], maxDepth?: number) => JsonValue;
+/**
+ * Converts a value to a pretty-printed JSON string, safely handling circular references and non-JSON types.
+ * @param value - The value to serialize.
+ * @param maxDepth - Maximum recursion depth.
+ * @returns A formatted JSON string.
+ */
 export declare const toSafeJsonString: (value: unknown, maxDepth?: number) => string;
+/**
+ * Converts a value to a JSON-safe representation, handling circular references and non-serializable types.
+ * @param value - The value to convert.
+ * @param maxDepth - Maximum recursion depth.
+ * @returns A JSON-safe value.
+ */
 export declare const toSafeJson: (value: unknown, maxDepth?: number) => JsonValue;
 //# sourceMappingURL=toSafeJson.d.ts.map

package/dist/neutral/toSafeJson.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"toSafeJson.d.ts","sourceRoot":"","sources":["../../src/toSafeJson.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EAAE,UAAU,EAAE,SAAS,EACjC,MAAM,iBAAiB,CAAA;AAExB,eAAO,MAAM,eAAe,GAAI,OAAO,OAAO,EAAE,EAAE,YAAY,OAAO,EAAE,EAAE,iBAAY,KAAG,SAEvF,CAAA;AAED,eAAO,MAAM,gBAAgB,GAAI,OAAO,MAAM,EAAE,YAAY,OAAO,EAAE,EAAE,iBAAY,KAAG,UAMrF,CAAA;AAED,eAAO,MAAM,eAAe,GAAI,OAAO,OAAO,EAAE,YAAY,OAAO,EAAE,EAAE,iBAAY,KAAG,SAyBrF,CAAA;AAED,eAAO,MAAM,gBAAgB,GAAI,OAAO,OAAO,EAAE,iBAAY,WAE5D,CAAA;AAED,eAAO,MAAM,UAAU,GAAI,OAAO,OAAO,EAAE,iBAAY,KAAG,SAEzD,CAAA"}
+{"version":3,"file":"toSafeJson.d.ts","sourceRoot":"","sources":["../../src/toSafeJson.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EAAE,UAAU,EAAE,SAAS,EACjC,MAAM,iBAAiB,CAAA;AAExB;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAI,OAAO,OAAO,EAAE,EAAE,YAAY,OAAO,EAAE,EAAE,iBAAY,KAAG,SAEvF,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAAI,OAAO,MAAM,EAAE,YAAY,OAAO,EAAE,EAAE,iBAAY,KAAG,UAMrF,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,GAAI,OAAO,OAAO,EAAE,YAAY,OAAO,EAAE,EAAE,iBAAY,KAAG,SAyBrF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,OAAO,OAAO,EAAE,iBAAY,WAE5D,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,OAAO,OAAO,EAAE,iBAAY,KAAG,SAEzD,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/object",
-  "version": "5.0.83",
+  "version": "5.0.84",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -39,15 +39,15 @@
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/assert": "~5.0.83",
-    "@xylabs/object-model": "~5.0.83",
-    "@xylabs/promise": "~5.0.83",
-    "@xylabs/typeof": "~5.0.83",
-    "@xylabs/zod": "~5.0.83"
+    "@xylabs/assert": "~5.0.84",
+    "@xylabs/object-model": "~5.0.84",
+    "@xylabs/promise": "~5.0.84",
+    "@xylabs/typeof": "~5.0.84",
+    "@xylabs/zod": "~5.0.84"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.4.11",
-    "@xylabs/tsconfig": "~7.4.11",
+    "@xylabs/ts-scripts-yarn3": "~7.4.13",
+    "@xylabs/tsconfig": "~7.4.13",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18",
     "zod": "^4.3.6"