Craigory V Coppola a1ccc87a07
docs(misc): documentation headers should include collectionName for searchability (#6451)
Signed-off-by: AgentEnder <craigorycoppola@gmail.com>
2021-07-21 11:40:59 -04:00

68 lines
970 B
Markdown

# @nrwl/react:redux
Create a redux slice for a project
## Usage
```bash
nx generate redux ...
```
```bash
nx g slice ... # same
```
By default, Nx will search for `redux` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react:redux ...
```
Show what will be generated without writing to disk:
```bash
nx g redux ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
Redux slice name.
### appProject
Alias(es): a
Type: `string`
The application project to add the slice to.
### directory
Alias(es): d
Type: `string`
The name of the folder used to contain/group the generated Redux files.
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### project
Alias(es): p
Type: `string`
The name of the project to add the slice to. If it is an application, then the store configuration will be updated too.