Skip to content

Document getProperty export in treebark package README #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Document getProperty export in treebark package README #70

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
aac0c4a
Initial plan
Copilot Oct 29, 2025
a1d56e6
Document getProperty export in README
Copilot Oct 29, 2025
952f10f
Fix parent access syntax in getProperty documentation
Copilot Oct 29, 2025
da2d536
Add simple property access example as the primary use case
Copilot Oct 29, 2025
099e783
Use concrete property names in parent access examples
Copilot Oct 29, 2025
41ee345
Remove example code from README.md
danmarshall Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions nodejs/packages/treebark/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,29 @@ Renders a template to DOM nodes (browser only).

**Returns:** `DocumentFragment` - DOM fragment containing rendered nodes

## Examples
### `getProperty(data, path, parents?, logger?, getOuterProperty?)`

Get a nested property from data using dot notation. This utility function is used internally by Treebark but is also exported for use in custom property resolution scenarios.

**Parameters:**
- `data: Data` - The data object to retrieve the property from
- `path: BindPath` - The property path using dot notation (e.g., `"user.name"` or `"items.0.value"`)
- `parents?: Data[]` - (Optional) Array of parent data contexts for parent property access
- `logger?: Logger` - (Optional) Logger instance for error messages
- `getOuterProperty?: OuterPropertyResolver` - (Optional) Fallback function called when property is not found

**Returns:** `unknown` - The value at the specified path, or `undefined` if not found

**Special path syntax:**
- `"propName"` - Access a simple property (e.g., `"name"`, `"age"`)
- `"user.name"` - Access nested properties with dot notation
- `"items.0"` - Access array elements by index
- `"."` - Returns the data object itself
- `"..parentProp"` - Access parent context (requires `parents` array)
- `"../../grandProp"` - Access grandparent context

For comprehensive examples, documentation, and advanced features, see the [main Treebark repository](https://github.com/danmarshall/treebark).

## License

MIT
MIT