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

29 lines
728 B
Markdown

# Function: getWorkspaceLayout
**getWorkspaceLayout**(`tree`): `Object`
Returns workspace defaults. It includes defaults folders for apps and libs,
and the default scope.
Example:
```typescript
{ appsDir: 'apps', libsDir: 'libs' }
```
#### Parameters
| Name | Type | Description |
| :----- | :-------------------------------------------------- | :--------------- |
| `tree` | [`Tree`](/reference/core-api/devkit/documents/Tree) | file system tree |
#### Returns
`Object`
| Name | Type |
| :-------------------- | :-------- |
| `appsDir` | `string` |
| `libsDir` | `string` |
| `standaloneAsDefault` | `boolean` |