nx/docs/generated/devkit/readProjectConfiguration.md

21 lines
883 B
Markdown

# Function: readProjectConfiguration
**readProjectConfiguration**(`tree`, `projectName`): [`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration)
Reads a project configuration.
**`Throws`**
If supplied projectName cannot be found
#### Parameters
| Name | Type | Description |
| :------------ | :------------------------------------ | :---------------------------------------------------------------------- |
| `tree` | [`Tree`](../../devkit/documents/Tree) | the file system tree |
| `projectName` | `string` | unique name. Often directories are part of the name (e.g., mydir-mylib) |
#### Returns
[`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration)