ast-get-values-by-key
Extract values and paths from AST by keys OR set them by keys
## Install
This package is [pure ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). If you're not ready yet, install an older version of this program, 3.1.0 (`npm i ast-get-values-by-key@3.1.0`).
```bash
npm i ast-get-values-by-key
```
## Quick Take
```js
import { strict as assert } from "assert";
import { getByKey } from "ast-get-values-by-key";
// GETTER
// ======
// returns "object-path" notation paths where arrays use dots:
assert.deepEqual(
getByKey(
{
parsed: [
{
tag: "html",
},
],
},
"tag", // value to search for
),
[{ val: "html", path: "parsed.0.tag" }],
);
// SETTER
// ======
assert.deepEqual(
getByKey(
{
parsed: [
{
tag: "html",
},
],
foo: {
tag: null,
},
bar: {
tag: null,
},
},
"tag", // value to search for
[123, 456], // pot of values to pick from (one result not enough)
),
{
parsed: [
{
tag: 123,
},
],
foo: {
tag: 456,
},
bar: {
tag: null, // value pot was depleted and there was nothing left to put here
},
},
);
```
## Documentation
Please [visit codsen.com](https://codsen.com/os/ast-get-values-by-key/) for a full description of the API.
## Contributing
To report bugs or request features or assistance, [raise an issue](https://github.com/codsen/codsen/issues/new/choose) on GitHub.
## Licence
MIT License.
Copyright © 2010-2025 Roy Revelt and other contributors.
