@nx/react:redux

Create a Redux state slice for a React project.

Usage

nx generate redux ...

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:

nx g @nx/react:redux ...

Show what will be generated without writing to disk:

nx g redux ... --dry-run

Examples

Generate a Redux state slice with the exported symbol matching the file name. It results in the slice fooSlice at mylib/src/lib/foo.slice.ts:

nx g @nx/react:redux mylib/src/lib/foo.slice.ts

Generate a Redux state slice with the exported symbol different from the file name. It results in the slice customSlice at mylib/src/lib/foo.slice.ts:

nx g @nx/react:redux mylib/src/lib/foo.slice.ts --name=custom

Generate a Redux state slice without providing the "slice" suffix and the file extension. It results in the slice fooSlice at mylib/src/lib/foo.slice.ts:

nx g @nx/react:redux mylib/src/lib/foo

Options

path

Required

string

The file path to the Redux state slice. Relative to the current working directory.

appProject

string

The application project to add the slice to.

name

string

The Redux state slice symbol name. Defaults to the last segment of the file path.

js

Deprecated

boolean

Generate JavaScript files rather than TypeScript files.

Provide the full file path including the file extension in the path option. This option will be removed in Nx v21.