@helpers4/object 2.0.0-alpha.9 → 2.0.0-beta.0

package/meta/api.json

@@ -1,7 +1,79 @@
 {
   "category": "object",
-  "version": "2.0.0-alpha.9",
+  "version": "2.0.0-beta.0",
   "functions": [
+    {
+      "name": "compact",
+      "kind": "function",
+      "description": "Removes all entries with falsy values (`false`, `null`, `undefined`, `0`, `\"\"`, `NaN`) from an object.",
+      "since": "2.0.0",
+      "signatures": [
+        {
+          "signature": "compact<T extends Record<string, unknown>>(obj: T): Partial<T>",
+          "description": "Removes all entries with falsy values (`false`, `null`, `undefined`, `0`, `\"\"`, `NaN`) from an object.",
+          "params": [
+            {
+              "name": "obj",
+              "type": "T",
+              "description": "The source object"
+            }
+          ],
+          "returns": {
+            "type": "Partial<T>",
+            "description": "A new object containing only entries with truthy values"
+          },
+          "typeParameters": [
+            {
+              "name": "T",
+              "constraint": "Record<string, unknown>"
+            }
+          ]
+        },
+        {
+          "signature": "compact(obj: undefined): undefined",
+          "description": "Removes all entries with falsy values (`false`, `null`, `undefined`, `0`, `\"\"`, `NaN`) from an object.",
+          "params": [
+            {
+              "name": "obj",
+              "type": "undefined",
+              "description": "The source object"
+            }
+          ],
+          "returns": {
+            "type": "undefined",
+            "description": "A new object containing only entries with truthy values"
+          }
+        },
+        {
+          "signature": "compact(obj: null): null",
+          "description": "Removes all entries with falsy values (`false`, `null`, `undefined`, `0`, `\"\"`, `NaN`) from an object.",
+          "params": [
+            {
+              "name": "obj",
+              "type": "null",
+              "description": "The source object"
+            }
+          ],
+          "returns": {
+            "type": "null",
+            "description": "A new object containing only entries with truthy values"
+          }
+        }
+      ],
+      "examples": [
+        {
+          "title": "Remove falsy values from object",
+          "description": "Removes all entries with falsy values (false, null, undefined, 0, \"\", NaN).",
+          "code": "compact({ a: 1, b: null, c: '', d: 0, e: 'hello' })\n// => { a: 1, e: 'hello' }"
+        },
+        {
+          "title": "Clean up API response",
+          "description": "Useful to strip empty or missing fields before sending data.",
+          "code": "compact({ name: 'Alice', email: '', age: 0, role: 'admin' })\n// => { name: 'Alice', role: 'admin' }"
+        }
+      ],
+      "sourceFile": "compact.ts"
+    },
     {
       "name": "deepClone",
       "kind": "function",
@@ -77,16 +149,14 @@
           "code": "deepCompare({ a: { b: 1 } }, { a: { b: 2 } })\n// => { a: { b: false } }"
         }
       ],
-      "sourceFile": "deepCompare.ts"
-    },
-    {
-      "name": "DeepCompareResult",
-      "kind": "interface",
-      "description": "Result type for deep comparison when objects are not identical",
-      "since": "2.0.0",
-      "signatures": [],
-      "examples": [],
-      "sourceFile": "deepCompare.ts"
+      "sourceFile": "deepCompare.ts",
+      "relatedTypes": [
+        {
+          "name": "DeepCompareResult",
+          "description": "Result type for deep comparison when objects are not identical",
+          "typeDefinition": "interface DeepCompareResult {}"
+        }
+      ]
     },
     {
       "name": "deepMerge",
@@ -95,7 +165,7 @@
       "since": "1.9.0",
       "signatures": [
         {
-          "signature": "deepMerge<T extends Record<string, any>>(target: T, sources: Record<string, any>[]): T",
+          "signature": "deepMerge<T extends Record<string, unknown>>(target: T, sources: Record<string, unknown>[]): T",
           "description": "Merges two or more objects deeply",
           "params": [
             {
@@ -105,7 +175,7 @@
             },
             {
               "name": "sources",
-              "type": "Record<string, any>[]",
+              "type": "Record<string, unknown>[]",
               "description": "The source objects to merge"
             }
           ],
@@ -116,9 +186,49 @@
           "typeParameters": [
             {
               "name": "T",
-              "constraint": "Record<string, any>"
+              "constraint": "Record<string, unknown>"
             }
           ]
+        },
+        {
+          "signature": "deepMerge(target: undefined, sources: Record<string, unknown>[]): undefined",
+          "description": "Merges two or more objects deeply",
+          "params": [
+            {
+              "name": "target",
+              "type": "undefined",
+              "description": "The target object"
+            },
+            {
+              "name": "sources",
+              "type": "Record<string, unknown>[]",
+              "description": "The source objects to merge"
+            }
+          ],
+          "returns": {
+            "type": "undefined",
+            "description": "The merged object"
+          }
+        },
+        {
+          "signature": "deepMerge(target: null, sources: Record<string, unknown>[]): null",
+          "description": "Merges two or more objects deeply",
+          "params": [
+            {
+              "name": "target",
+              "type": "null",
+              "description": "The target object"
+            },
+            {
+              "name": "sources",
+              "type": "Record<string, unknown>[]",
+              "description": "The source objects to merge"
+            }
+          ],
+          "returns": {
+            "type": "null",
+            "description": "The merged object"
+          }
         }
       ],
       "examples": [
@@ -137,12 +247,12 @@
       "since": "1.9.0",
       "signatures": [
         {
-          "signature": "get<T = any>(obj: any, path: string, defaultValue?: T): T | undefined",
+          "signature": "get<T = unknown>(obj: unknown, path: string, defaultValue?: T): T | undefined",
           "description": "Gets a value from an object using a dot-notated path",
           "params": [
             {
               "name": "obj",
-              "type": "any",
+              "type": "unknown",
               "description": "The object to get value from"
             },
             {
@@ -164,7 +274,7 @@
           "typeParameters": [
             {
               "name": "T",
-              "default": "any"
+              "default": "unknown"
             }
           ]
         }
@@ -184,40 +294,186 @@
       "sourceFile": "get.ts"
     },
     {
-      "name": "quickCompare",
+      "name": "omit",
       "kind": "function",
-      "description": "Quick comparison of two objects using JSON.stringify.\nThis is a fast but simple comparison that may not work for all edge cases.",
+      "description": "Creates a new object without the specified keys.",
       "since": "2.0.0",
       "signatures": [
         {
-          "signature": "quickCompare(objA: unknown, objB: unknown): boolean",
-          "description": "Quick comparison of two objects using JSON.stringify.\nThis is a fast but simple comparison that may not work for all edge cases.",
+          "signature": "omit<T extends Record<string, unknown>, K extends string | number | symbol>(obj: T, keys: readonly K[]): Omit<T, K>",
+          "description": "Creates a new object without the specified keys.",
           "params": [
             {
-              "name": "objA",
-              "type": "unknown",
-              "description": "First object to compare"
+              "name": "obj",
+              "type": "T",
+              "description": "The source object"
             },
             {
-              "name": "objB",
-              "type": "unknown",
-              "description": "Second object to compare"
+              "name": "keys",
+              "type": "readonly K[]",
+              "description": "The keys to omit"
             }
           ],
           "returns": {
-            "type": "boolean",
-            "description": "`true` if objects are identical according to JSON.stringify, `false` otherwise"
+            "type": "Omit<T, K>",
+            "description": "A new object without the omitted keys"
+          },
+          "typeParameters": [
+            {
+              "name": "T",
+              "constraint": "Record<string, unknown>"
+            },
+            {
+              "name": "K",
+              "constraint": "string | number | symbol"
+            }
+          ]
+        },
+        {
+          "signature": "omit(obj: undefined, keys: readonly string[]): undefined",
+          "description": "Creates a new object without the specified keys.",
+          "params": [
+            {
+              "name": "obj",
+              "type": "undefined",
+              "description": "The source object"
+            },
+            {
+              "name": "keys",
+              "type": "readonly string[]",
+              "description": "The keys to omit"
+            }
+          ],
+          "returns": {
+            "type": "undefined",
+            "description": "A new object without the omitted keys"
+          }
+        },
+        {
+          "signature": "omit(obj: null, keys: readonly string[]): null",
+          "description": "Creates a new object without the specified keys.",
+          "params": [
+            {
+              "name": "obj",
+              "type": "null",
+              "description": "The source object"
+            },
+            {
+              "name": "keys",
+              "type": "readonly string[]",
+              "description": "The keys to omit"
+            }
+          ],
+          "returns": {
+            "type": "null",
+            "description": "A new object without the omitted keys"
           }
         }
       ],
       "examples": [
         {
-          "title": "Compare two equal objects",
-          "description": "Uses JSON.stringify for a fast comparison.",
-          "code": "quickCompare({ a: 1, b: 2 }, { a: 1, b: 2 })\n// => true"
+          "title": "Omit specific keys",
+          "description": "Creates a new object without the specified keys.",
+          "code": "omit({ a: 1, b: 2, c: 3 }, ['b'])\n// => { a: 1, c: 3 }"
+        },
+        {
+          "title": "Remove sensitive fields",
+          "description": "Useful to strip sensitive data before sending to client.",
+          "code": "const user = { id: 1, name: 'Alice', password: 'secret', token: 'abc123' };\nomit(user, ['password', 'token'])\n// => { id: 1, name: 'Alice' }"
         }
       ],
-      "sourceFile": "quickCompare.ts"
+      "sourceFile": "omit.ts"
+    },
+    {
+      "name": "pick",
+      "kind": "function",
+      "description": "Creates a new object with only the specified keys.",
+      "since": "2.0.0",
+      "signatures": [
+        {
+          "signature": "pick<T extends Record<string, unknown>, K extends string | number | symbol>(obj: T, keys: readonly K[]): Pick<T, K>",
+          "description": "Creates a new object with only the specified keys.",
+          "params": [
+            {
+              "name": "obj",
+              "type": "T",
+              "description": "The source object"
+            },
+            {
+              "name": "keys",
+              "type": "readonly K[]",
+              "description": "The keys to pick"
+            }
+          ],
+          "returns": {
+            "type": "Pick<T, K>",
+            "description": "A new object with only the picked keys"
+          },
+          "typeParameters": [
+            {
+              "name": "T",
+              "constraint": "Record<string, unknown>"
+            },
+            {
+              "name": "K",
+              "constraint": "string | number | symbol"
+            }
+          ]
+        },
+        {
+          "signature": "pick(obj: undefined, keys: readonly string[]): undefined",
+          "description": "Creates a new object with only the specified keys.",
+          "params": [
+            {
+              "name": "obj",
+              "type": "undefined",
+              "description": "The source object"
+            },
+            {
+              "name": "keys",
+              "type": "readonly string[]",
+              "description": "The keys to pick"
+            }
+          ],
+          "returns": {
+            "type": "undefined",
+            "description": "A new object with only the picked keys"
+          }
+        },
+        {
+          "signature": "pick(obj: null, keys: readonly string[]): null",
+          "description": "Creates a new object with only the specified keys.",
+          "params": [
+            {
+              "name": "obj",
+              "type": "null",
+              "description": "The source object"
+            },
+            {
+              "name": "keys",
+              "type": "readonly string[]",
+              "description": "The keys to pick"
+            }
+          ],
+          "returns": {
+            "type": "null",
+            "description": "A new object with only the picked keys"
+          }
+        }
+      ],
+      "examples": [
+        {
+          "title": "Pick specific keys",
+          "description": "Creates a new object with only the specified keys.",
+          "code": "pick({ a: 1, b: 2, c: 3 }, ['a', 'c'])\n// => { a: 1, c: 3 }"
+        },
+        {
+          "title": "Extract user fields",
+          "description": "Useful to select only the fields you need from an object.",
+          "code": "const user = { id: 1, name: 'Alice', email: 'alice@example.com', password: 'secret' };\npick(user, ['id', 'name', 'email'])\n// => { id: 1, name: 'Alice', email: 'alice@example.com' }"
+        }
+      ],
+      "sourceFile": "pick.ts"
     },
     {
       "name": "removeUndefinedNull",
@@ -286,6 +542,77 @@
       ],
       "sourceFile": "removeUndefinedNull.ts"
     },
+    {
+      "name": "safeJsonParse",
+      "kind": "function",
+      "description": "Parses a JSON string, returning `null` (or a fallback) on any parse failure.\n\nUnlike `JSON.parse`, this never throws. Invalid JSON strings and other\nparsing edge-cases resolve to `null` or the provided `fallback`.",
+      "since": "next",
+      "signatures": [
+        {
+          "signature": "safeJsonParse<T>(input: string): T | null",
+          "description": "Parses a JSON string, returning `null` (or a fallback) on any parse failure.\n\nUnlike `JSON.parse`, this never throws. Invalid JSON strings and other\nparsing edge-cases resolve to `null` or the provided `fallback`.",
+          "params": [
+            {
+              "name": "input",
+              "type": "string",
+              "description": "The JSON string to parse."
+            }
+          ],
+          "returns": {
+            "type": "T | null",
+            "description": "The parsed value typed as `T`, or `fallback` on failure."
+          },
+          "typeParameters": [
+            {
+              "name": "T"
+            }
+          ]
+        },
+        {
+          "signature": "safeJsonParse<T>(input: string, fallback: T): T",
+          "description": "Parses a JSON string, returning `null` (or a fallback) on any parse failure.\n\nUnlike `JSON.parse`, this never throws. Invalid JSON strings and other\nparsing edge-cases resolve to `null` or the provided `fallback`.",
+          "params": [
+            {
+              "name": "input",
+              "type": "string",
+              "description": "The JSON string to parse."
+            },
+            {
+              "name": "fallback",
+              "type": "T",
+              "description": "Value returned on failure. Defaults to `null` when omitted."
+            }
+          ],
+          "returns": {
+            "type": "T",
+            "description": "The parsed value typed as `T`, or `fallback` on failure."
+          },
+          "typeParameters": [
+            {
+              "name": "T"
+            }
+          ]
+        }
+      ],
+      "examples": [
+        {
+          "title": "Parse valid JSON",
+          "description": "Returns the parsed value when the input is valid JSON.",
+          "code": "safeJsonParse<{ a: number }>('{\"a\":1}')\n// => { a: 1 }"
+        },
+        {
+          "title": "Return null on invalid input",
+          "description": "Returns null instead of throwing when JSON is malformed.",
+          "code": "safeJsonParse('invalid')\n// => null"
+        },
+        {
+          "title": "Use a fallback value",
+          "description": "Returns the provided fallback when parsing fails.",
+          "code": "safeJsonParse('invalid', [])\n// => []"
+        }
+      ],
+      "sourceFile": "safeJsonParse.ts"
+    },
     {
       "name": "set",
       "kind": "function",
@@ -293,12 +620,12 @@
       "since": "1.9.0",
       "signatures": [
         {
-          "signature": "set(obj: Record<string, any>, path: string, value: any): Record<string, any>",
+          "signature": "set(obj: Record<string, unknown>, path: string, value: unknown): Record<string, unknown>",
           "description": "Sets a value in an object using a dot-notated path",
           "params": [
             {
               "name": "obj",
-              "type": "Record<string, any>",
+              "type": "Record<string, unknown>",
               "description": "The object to set value in"
             },
             {
@@ -308,12 +635,12 @@
             },
             {
               "name": "value",
-              "type": "any",
+              "type": "unknown",
               "description": "The value to set"
             }
           ],
           "returns": {
-            "type": "Record<string, any>",
+            "type": "Record<string, unknown>",
             "description": "The modified object"
           }
         }
@@ -326,6 +653,42 @@
         }
       ],
       "sourceFile": "set.ts"
+    },
+    {
+      "name": "shallowEquals",
+      "kind": "function",
+      "description": "Quick comparison of two objects using JSON.stringify.\nThis is a fast but simple comparison that may not work for all edge cases.",
+      "since": "2.0.0",
+      "signatures": [
+        {
+          "signature": "shallowEquals(objA: unknown, objB: unknown): boolean",
+          "description": "Quick comparison of two objects using JSON.stringify.\nThis is a fast but simple comparison that may not work for all edge cases.",
+          "params": [
+            {
+              "name": "objA",
+              "type": "unknown",
+              "description": "First object to compare"
+            },
+            {
+              "name": "objB",
+              "type": "unknown",
+              "description": "Second object to compare"
+            }
+          ],
+          "returns": {
+            "type": "boolean",
+            "description": "`true` if objects are identical according to JSON.stringify, `false` otherwise"
+          }
+        }
+      ],
+      "examples": [
+        {
+          "title": "Compare two equal objects",
+          "description": "Uses JSON.stringify for a fast comparison.",
+          "code": "shallowEquals({ a: 1, b: 2 }, { a: 1, b: 2 })\n// => true"
+        }
+      ],
+      "sourceFile": "shallowEquals.ts"
     }
   ]
 }

package/meta/category.json

@@ -0,0 +1,6 @@
+{
+  "category": "object",
+  "label": "Object",
+  "smallDescription": "Object manipulation utilities",
+  "description": "Utilities for working with objects including property removal, filtering, and object transformation"
+}

package/meta/examples.json

@@ -1,6 +1,21 @@
 {
   "category": "object",
   "functions": [
+    {
+      "name": "compact",
+      "examples": [
+        {
+          "title": "Remove falsy values from object",
+          "description": "Removes all entries with falsy values (false, null, undefined, 0, \"\", NaN).",
+          "code": "compact({ a: 1, b: null, c: '', d: 0, e: 'hello' })\n// => { a: 1, e: 'hello' }"
+        },
+        {
+          "title": "Clean up API response",
+          "description": "Useful to strip empty or missing fields before sending data.",
+          "code": "compact({ name: 'Alice', email: '', age: 0, role: 'admin' })\n// => { name: 'Alice', role: 'admin' }"
+        }
+      ]
+    },
     {
       "name": "deepClone",
       "examples": [
@@ -52,12 +67,32 @@
       ]
     },
     {
-      "name": "quickCompare",
+      "name": "omit",
       "examples": [
         {
-          "title": "Compare two equal objects",
-          "description": "Uses JSON.stringify for a fast comparison.",
-          "code": "quickCompare({ a: 1, b: 2 }, { a: 1, b: 2 })\n// => true"
+          "title": "Omit specific keys",
+          "description": "Creates a new object without the specified keys.",
+          "code": "omit({ a: 1, b: 2, c: 3 }, ['b'])\n// => { a: 1, c: 3 }"
+        },
+        {
+          "title": "Remove sensitive fields",
+          "description": "Useful to strip sensitive data before sending to client.",
+          "code": "const user = { id: 1, name: 'Alice', password: 'secret', token: 'abc123' };\nomit(user, ['password', 'token'])\n// => { id: 1, name: 'Alice' }"
+        }
+      ]
+    },
+    {
+      "name": "pick",
+      "examples": [
+        {
+          "title": "Pick specific keys",
+          "description": "Creates a new object with only the specified keys.",
+          "code": "pick({ a: 1, b: 2, c: 3 }, ['a', 'c'])\n// => { a: 1, c: 3 }"
+        },
+        {
+          "title": "Extract user fields",
+          "description": "Useful to select only the fields you need from an object.",
+          "code": "const user = { id: 1, name: 'Alice', email: 'alice@example.com', password: 'secret' };\npick(user, ['id', 'name', 'email'])\n// => { id: 1, name: 'Alice', email: 'alice@example.com' }"
         }
       ]
     },
@@ -71,6 +106,26 @@
         }
       ]
     },
+    {
+      "name": "safeJsonParse",
+      "examples": [
+        {
+          "title": "Parse valid JSON",
+          "description": "Returns the parsed value when the input is valid JSON.",
+          "code": "safeJsonParse<{ a: number }>('{\"a\":1}')\n// => { a: 1 }"
+        },
+        {
+          "title": "Return null on invalid input",
+          "description": "Returns null instead of throwing when JSON is malformed.",
+          "code": "safeJsonParse('invalid')\n// => null"
+        },
+        {
+          "title": "Use a fallback value",
+          "description": "Returns the provided fallback when parsing fails.",
+          "code": "safeJsonParse('invalid', [])\n// => []"
+        }
+      ]
+    },
     {
       "name": "set",
       "examples": [
@@ -80,6 +135,16 @@
           "code": "set({}, 'a.b.c', 42)\n// => { a: { b: { c: 42 } } }"
         }
       ]
+    },
+    {
+      "name": "shallowEquals",
+      "examples": [
+        {
+          "title": "Compare two equal objects",
+          "description": "Uses JSON.stringify for a fast comparison.",
+          "code": "shallowEquals({ a: 1, b: 2 }, { a: 1, b: 2 })\n// => true"
+        }
+      ]
     }
   ]
 }

package/meta/licenses.json

@@ -1,11 +1,4 @@
 {
   "category": "object",
-  "dependencies": [
-    {
-      "name": "radashi",
-      "license": "MIT",
-      "homepage": "https://radashi.js.org",
-      "repository": "https://github.com/radashi-org/radashi"
-    }
-  ]
+  "dependencies": []
 }