b51676a89a
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>
23 lines
780 B
Markdown
23 lines
780 B
Markdown
# Type alias: Migration
|
|
|
|
Ƭ **Migration**: (`tree`: [`Tree`](/reference/core-api/devkit/documents/Tree)) => `void` \| `Promise`\<`void`\> \| `string`[] \| `Promise`\<`string`[]\>
|
|
|
|
Represents a migration that is executed when running `nx migrate`.
|
|
|
|
Returning a string[] from the migration function will be interpreted as
|
|
a list of next steps to be displayed to the user.
|
|
|
|
#### Type declaration
|
|
|
|
▸ (`tree`): `void` \| `Promise`\<`void`\> \| `string`[] \| `Promise`\<`string`[]\>
|
|
|
|
##### Parameters
|
|
|
|
| Name | Type |
|
|
| :----- | :-------------------------------------------------- |
|
|
| `tree` | [`Tree`](/reference/core-api/devkit/documents/Tree) |
|
|
|
|
##### Returns
|
|
|
|
`void` \| `Promise`\<`void`\> \| `string`[] \| `Promise`\<`string`[]\>
|