dynamic-forms / Function

parseArrayPath

Parses an array derivation path into its components.

Array paths use the $ placeholder to represent "any index". Format: "arrayPath.$.relativePath"

Presentation

function parseArrayPath(path: string): ArrayPathInfo;

Returns

ArrayPathInfo -

Parsed path info with arrayPath and relativePath

Parameters

NameTypeDescription
path
string

The path to parse (e.g., "items.$.quantity")

Example usage

parseArrayPath('items.$.quantity')
// { arrayPath: 'items', relativePath: 'quantity', isArrayPath: true }

parseArrayPath('orders.lineItems.$.total')
// { arrayPath: 'orders.lineItems', relativePath: 'total', isArrayPath: true }

parseArrayPath('simpleField')
// { arrayPath: '', relativePath: '', isArrayPath: false }