nx/docs/generated/devkit/updateJson.md
Juri Strumpflohner b51676a89a
docs(core): restructure guides into technologies sections (#31288)
Updates the docs structure, navigation etc to be easier + better suited
for showing Nx technology support beyond just TS.

**Notes:**

- API (`/nx-api`) tab is removed from the navigation (i.e. menu bar),
but pages still remain for now until we update references in `*.md`
files.
- Redirects are set up `/nx-api` to go to their respect new location
e.g. `/technologies` or `/reference/core-api`
- Old URLs still exist in the sitemap for now, but majority of them will
be redirected -- a follow-up PR can remove them.

**Preview:**
https://nx-dev-git-nx-dev-polyglot-docs-restructure-nrwl.vercel.app/docs

---------

Co-authored-by: Jack Hsu <jack.hsu@gmail.com>
2025-05-29 14:55:34 -04:00

26 lines
2.0 KiB
Markdown

# Function: updateJson
**updateJson**\<`T`, `U`\>(`tree`, `path`, `updater`, `options?`): `void`
Updates a JSON value to the file system tree
#### Type parameters
| Name | Type |
| :--- | :----------------------- |
| `T` | extends `object` = `any` |
| `U` | extends `object` = `T` |
#### Parameters
| Name | Type | Description |
| :--------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------- |
| `tree` | [`Tree`](/reference/core-api/devkit/documents/Tree) | File system tree |
| `path` | `string` | Path of JSON file in the Tree |
| `updater` | (`value`: `T`) => `U` | Function that maps the current value of a JSON document to a new value to be written to the document |
| `options?` | [`JsonParseOptions`](/reference/core-api/devkit/documents/JsonParseOptions) & [`JsonSerializeOptions`](/reference/core-api/devkit/documents/JsonSerializeOptions) | Optional JSON Parse and Serialize Options |
#### Returns
`void`