Registry / serialization / js-object-utilities

js-object-utilities

library2.2.1jsnpmunverified

js-object-utilities is a lightweight JavaScript package providing a collection of helper methods designed for working with nested objects. It simplifies common tasks like accessing, setting, deleting, and transforming deeply nested properties using dot-notation paths. Currently at version 2.2.1, the library maintains a stable release cadence. Key differentiators include its focus on handling complex object structures gracefully, providing utilities for deep equality checks, detecting circular references, and clearing empty objects, which are often overlooked in more general-purpose utility libraries. It ships with TypeScript type definitions, enhancing development experience for TypeScript users.

serialization

npm install js-object-utilities

github ↗package ↗

INSTALL

IMPORT

SIG · JS-OBJECT-UTILITIE

js-object-utilities

serializationjavascriptv2.2.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

objectUtils

✓ import objectUtils from 'js-object-utilities';

✗ import { objectUtils } from 'js-object-utilities';

The library is exported as a default object containing all utilities. Named imports like `{ get }` are not supported directly from the root module.

objectUtils (CommonJS)

✓ const objectUtils = require('js-object-utilities');

✗ const { get } = require('js-object-utilities');

For CommonJS environments, the entire utility object is exported as default, requiring the module as a single variable.

Type definitions

✓ import type { ObjectUtilities } from 'js-object-utilities';

The package ships with TypeScript definitions. If you need to type the imported utility object, you can use the `ObjectUtilities` interface.

Demonstrates `get`, `set`, `pick`, `delete`, `clearEmpties`, and `isCircular` on a nested object, including how to set up a circular reference.

import objectUtils from 'js-object-utilities'; interface MyObject { data: { hello: string; space?: string; node?: string; otherData?: Record<string, unknown>; }; array?: { first: number }; array2?: MyObject; } let myObject: MyObject = { data: { hello: 'world', space: 'travel', node: 'npm', otherData: {} } }; console.log('Original object:', JSON.stringify(myObject, null, 2)); // Get a nested value const helloValue = objectUtils.get(myObject, 'data.hello'); console.log(`Value of 'data.hello': ${helloValue}`); // Expected: world // Set a nested value objectUtils.set(myObject, 'data.hello', 'universe'); console.log('After setting data.hello:', JSON.stringify(myObject, null, 2)); // Expected: universe // Pick specific keys to create a new object const pickedObject = objectUtils.pick(myObject, ['data.hello', 'data.space']); console.log('Picked object:', JSON.stringify(pickedObject, null, 2)); // Expected: { "data": { "hello": "universe", "space": "travel" } } // Delete a nested key objectUtils.delete(myObject, 'data.node'); console.log('After deleting data.node:', JSON.stringify(myObject, null, 2)); // Clear empty objects objectUtils.clearEmpties(myObject); console.log('After clearing empties:', JSON.stringify(myObject, null, 2)); // 'otherData' should be removed // Check for circularity let circularObject: MyObject = { data: { hello: 'circular' } }; circularObject.array2 = circularObject; // Create circular reference console.log('Is circular object circular?', objectUtils.isCircular(circularObject)); // Expected: true

Debug

Known issues

gotchaSeveral utility functions like `set`, `delete`, and `clearEmpties` mutate the original object directly. Be mindful of this behavior when working with immutable state patterns or shared objects.

fix

If immutability is required, ensure you clone the object before passing it to mutating functions (e.g., using `structuredClone` or a deep merge utility) or use functions that explicitly return new objects, like `pick`.

affects: >=1.0.0

gotchaThe README example for `objectutils.pick` incorrectly shows `objectutils.delete` being called, but the description correctly states `pick` returns a new object with selected keys. Rely on the description and the expected behavior of a 'pick' function rather than the erroneous code snippet in the README.

fix

When using `objectutils.pick`, expect it to return a *new* object containing only the specified keys, leaving the original object unchanged. Do not confuse it with `delete`'s in-place mutation.

affects: >=1.0.0

gotchaThe `isCircular` function is crucial for preventing infinite loops or stack overflows when stringifying or processing objects with circular references. Failing to check for circularity can lead to runtime errors in JSON serialization or other recursive operations.

fix

Always use `objectUtils.isCircular(obj)` before performing operations like `JSON.stringify()` on objects that might contain self-referential structures.

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: objectutils.get is not a function

Attempting to use named imports (e.g., `import { get } from 'js-object-utilities'`) when the package only provides a default export object.

fix

Use the correct default import pattern: `import objectUtils from 'js-object-utilities';` then access methods as `objectUtils.get(obj, key);`.

Cannot read properties of undefined (reading 'hello')

This error occurs when a property is accessed on an `undefined` or `null` object during a nested path traversal, indicating an intermediate path segment does not exist. While `objectUtils.get` handles non-existent paths by returning `undefined`, this error typically arises when you try to access a sub-property of the `undefined` result from `get` without null-checking.

fix

Ensure the object passed to `objectUtils.get` is not `undefined` or `null`. Always check the return value of `objectUtils.get` before attempting further property access, e.g., `const value = objectUtils.get(obj, 'path'); if (value !== undefined) { /* use value */ }`.

RangeError: Maximum call stack size exceeded

Attempting to stringify (`JSON.stringify`) or deeply clone an object that contains circular references without first detecting and handling them.

fix

Before performing operations sensitive to circular references, use `objectUtils.isCircular(obj)` to check for their presence. If detected, you'll need to either remove the circular reference, transform the object, or use a custom replacer function for `JSON.stringify`.

Upgrade

Version history

2.2.1latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/rrainn/js-object-utilities ↗

packagehttps://www.npmjs.com/package/js-object-utilities ↗