@nx/nestSee schema

@nx/nest:resource

Nest Resource Options Schema.

Usage

1nx generate resource ... 2

By default, Nx will search for resource in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

1nx g @nx/nest:resource ... 2

Show what will be generated without writing to disk:

1nx g resource ... --dry-run 2

Examples

Generate myapp/src/app/entities/foo.entity.ts, myapp/src/app/dto/create-foo.dto.ts, myapp/src/app/dto/update-foo.dto.ts, myapp/src/app/foo.service.ts, myapp/src/app/foo.controller.ts, and myapp/src/app/foo.module.ts:

1nx g @nx/nest:resource myapp/src/app/foo 2

Options

path

Required
string

The file path to the resource without the file extension and suffix. Relative to the current working directory.

crud

boolean
Default: true

When true, CRUD entry points are generated.

language

string
Accepted values: js, ts

Nest class language.

skipImport

boolean
Default: false

Flag to skip the module import.

type

string
Default: rest
Accepted values: rest, graphql-code-first, graphql-schema-first, microservice, ws

The transport layer.

unitTestRunner

string
Default: jest
Accepted values: jest, none

Test runner to use for unit tests.

skipFormat

Internal
boolean
Default: false

Skip formatting files.