resolvePath

Resolve dot/bracket notation paths against JSON values.

Signature

function resolvePath(
  root: unknown,
  path: string,
  maxItems?: number
): ResolveResult | ResolveError;

Parameters

Parameter	Type	Default	Description
root	unknown	—	The JSON value to resolve against
path	string	—	Dot/bracket path (e.g. data.users[0].name)
maxItems	number	5	Max elements to return for wildcard [*] paths

Path Syntax

Syntax	Description	Example
key	Object key access	data.users
[0]	Array index	data.users[0]
[*]	Wildcard (all elements)	data.users[*].name

Try it: Key and Index Access

resolvePath()

path

Input

{
  "data": {
    "users": [
      { "id": 1, "name": "Alice" },
      { "id": 2, "name": "Bob" },
      { "id": 3, "name": "Charlie" }
    ]
  },
  "meta": { "total": 3 }
}

{ "data": { "users": [ { "id": 1, "name": "Alice" }, { "id": 2, "name": "Bob" }, { "id": 3, "name": "Charlie" } ] }, "meta": { "total": 3 } }

Output

Try it: Wildcards

Change the path to data.users[*].name to get all names. Try data.users[*].id for IDs.

resolvePath()

path

Input

{
  "data": {
    "users": [
      { "id": 1, "name": "Alice" },
      { "id": 2, "name": "Bob" },
      { "id": 3, "name": "Charlie" },
      { "id": 4, "name": "Diana" },
      { "id": 5, "name": "Eve" },
      { "id": 6, "name": "Frank" }
    ]
  }
}

{ "data": { "users": [ { "id": 1, "name": "Alice" }, { "id": 2, "name": "Bob" }, { "id": 3, "name": "Charlie" }, { "id": 4, "name": "Diana" }, { "id": 5, "name": "Eve" }, { "id": 6, "name": "Frank" } ] } }

Output

Return Types

Success:

interface ResolveResult {
  ok: true;
  value: unknown;
  isWildcard: boolean;
  totalItems?: number;  // for wildcard: total elements in array
}

Error:

interface ResolveError {
  ok: false;
  error: string;  // descriptive message with available keys
}

Try it: Error Messages

Try paths that don't exist to see structured error messages. For example: data.missing or data.users[99].

resolvePath()

path

Input

{
  "data": {
    "users": [
      { "id": 1, "name": "Alice" }
    ]
  }
}

{ "data": { "users": [ { "id": 1, "name": "Alice" } ] } }

Output