nx/docs/generated/devkit/FileChange.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

45 lines
912 B
Markdown

# Interface: FileChange
Description of a file change in the Nx virtual file system/
## Table of contents
### Properties
- [content](/reference/core-api/devkit/documents/FileChange#content): Buffer<ArrayBufferLike>
- [options](/reference/core-api/devkit/documents/FileChange#options): TreeWriteOptions
- [path](/reference/core-api/devkit/documents/FileChange#path): string
- [type](/reference/core-api/devkit/documents/FileChange#type): "CREATE" | "DELETE" | "UPDATE"
## Properties
### content
**content**: `Buffer`\<`ArrayBufferLike`\>
The content of the file or null in case of delete.
---
### options
`Optional` **options**: `TreeWriteOptions`
Options to set on the file being created or updated.
---
### path
**path**: `string`
Path relative to the workspace root
---
### type
**type**: `"CREATE"` \| `"DELETE"` \| `"UPDATE"`
Type of change: 'CREATE' | 'DELETE' | 'UPDATE'