object-bystring

object-bystring

Access and alter deeply nested object properties by string notation

Purpose

Let's say you want to change a something nested in this object:

var objA = {
  name: "tamb",
  address: {
    street: "123 fake street",
    town: "fake town",
    zip: "00000",
    state: "Fake State",
    city: "Fake City",
    POBoxes: [1234, 23213, 2321],
  },
  dependents: [
    {
      name: "John Doe",
      age: 55,
    },
    {
      name: "Jane Doe",
      age: 44,
    },
  ],
};

You coould easily write objA.dependents[1].age = 45;
Or even var indx = 1; objA.dependents[indx].age = 45;

No issue here.

But let's say you are trying to pass along an object (objB) of commands. Those commands should dictate what to change in objA.

How do you easily do this?

{
 'address.street': '345 Faker Way',
 'dependents[1].age': 45,
 'address.POBoxes[2]': 43278
}

With byString you can generate paths to object values and either set or get those values.

Latest Docs:

https://github.com/tamb/object-bystring

Demo

https://codesandbox.io/embed/object-bystring-demo-i3845d?fontsize=14&hidenavigation=1&theme=dark

installation

npm install --save object-bystring

Usage

You can import either a utility method, or a polyfill to add this functionality to the Object prototype.

// util method
const { bystring } = require("object-bystring");
import { byString } from "object-bystring";

Using the example above:

Setting Values

byString(object, key, value)

byString(objectA, "path.to.field", "new value");

setting values for fields that don't exist will add them to the object. Setting values for array indexes that don't exist will add them to the array and other indexes will be undefined.

### Getting Values

#### `byString(object, key);`

```js
const finger = byString(person, "arm[0].hand.fingers[3]");

const randomFinger = byString(person`arm[0].hand.fingers[${number}]`);

Getting values for fields that don't exist will return undefined.

Performance & Optimization History

The byString function has undergone significant optimizations across multiple versions:

V8 (Current) - Ultra-Optimized

V8 delivers 79.55% performance improvement over the original version (5,000,000 iterations):

Version	Time	vs Original	vs V7
Original	1,034.04ms	-	-
V7	543.41ms	47.46% faster	-
V8 (Ultra)	211.45ms	79.55% faster	61.09% faster

V8 Key Optimizations:

• Single-pass, zero-allocation inline algorithm
• Eliminated helper functions and intermediate objects
• Direct array/object creation and navigation
• Optimized peek-ahead logic for type determination
• Minimal string slicing operations

V7 Optimizations

V7 introduced modular architecture with:

• Character-by-character parser (replaced regex)
• Separated concerns (parseKey, setValue, getValue)
• Enhanced TypeScript support and type safety
• Better error handling and edge case coverage

Breaking Changes in V8

⚠️ Important: V8 introduces breaking changes for edge cases:

1. Malformed Array Syntax

// Before (Original/V7): Creates nested property
byString(obj, "array[", "value");
// Result: obj.array["["] = "value"

// After (V8): Creates literal property name
byString(obj, "array[", "value");
// Result: obj["array["] = "value"

2. Non-numeric Array Indices

// Before (Original/V7): Creates nested property
byString(obj, "array[abc]", "value");
// Result: obj.array["[abc]"] = "value"

// After (V8): Creates literal property name
byString(obj, "array[abc]", "value");
// Result: obj["array[abc]"] = "value"

Impact: These changes affect only malformed or non-standard syntax. Valid array notation (array[0], array[123]) and object notation (obj.prop) work identically.

Recommendation: Use proper syntax (array[0] for arrays, obj.prop for objects) to avoid these edge cases.

Attribution

Thank you, Ray for the original Stackoverflow answer, which is the inspiration for this project. https://stackoverflow.com/questions/6491463/accessing-nested-javascript-objects-with-string-key

Check out his github and so profile below:

https://github.com/raybellis

https://stackoverflow.com/users/6782/alnitak