69 lines
1.2 KiB
Markdown
69 lines
1.2 KiB
Markdown
---
|
|
title: '@nrwl/js:tsc executor'
|
|
description: 'Build a project using TypeScript.'
|
|
---
|
|
|
|
# @nrwl/js:tsc
|
|
|
|
Build a project using TypeScript.
|
|
|
|
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
|
|
|
|
## Options
|
|
|
|
### main (_**required**_)
|
|
|
|
Type: `string`
|
|
|
|
The name of the main entry-point file.
|
|
|
|
### outputPath (_**required**_)
|
|
|
|
Type: `string`
|
|
|
|
The output path of the generated files.
|
|
|
|
### tsConfig (_**required**_)
|
|
|
|
Type: `string`
|
|
|
|
The path to the Typescript configuration file.
|
|
|
|
### assets
|
|
|
|
Type: `array`
|
|
|
|
List of static assets.
|
|
|
|
### buildableProjectDepsInPackageJsonType
|
|
|
|
Default: `peerDependencies`
|
|
|
|
Type: `string`
|
|
|
|
Possible values: `dependencies`, `peerDependencies`
|
|
|
|
When `updateBuildableProjectDepsInPackageJson` is `true`, this adds dependencies to either `peerDependencies` or `dependencies`.
|
|
|
|
### transformers
|
|
|
|
Type: `array`
|
|
|
|
List of TypeScript Transformer Plugins.
|
|
|
|
### updateBuildableProjectDepsInPackageJson
|
|
|
|
Default: `true`
|
|
|
|
Type: `boolean`
|
|
|
|
Whether to update the buildable project dependencies in package.json.
|
|
|
|
### watch
|
|
|
|
Default: `false`
|
|
|
|
Type: `boolean`
|
|
|
|
Enable re-building when files change.
|