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

92 lines
1.4 KiB
Markdown

# @nrwl/node:package
Package a Node library
Options can be configured in `angular.json` when defining the executor, or when invoking it.
## Options
### main (_**required**_)
Type: `string`
The name of the main entry-point file.
### tsConfig (_**required**_)
Type: `string`
The name of the Typescript configuration file.
### assets
Type: `array`
List of static library assets.
### buildableProjectDepsInPackageJsonType
Default: `dependencies`
Type: `string`
Possible values: `dependencies`, `peerDependencies`
When updateBuildableProjectDepsInPackageJson is true, this adds dependencies to either `peerDependencies` or `dependencies`
### cli
Type: `boolean`
Adds a CLI wrapper to main entry-point file.
### deleteOutputPath
Default: `true`
Type: `boolean`
Delete the output path before building.
### outputPath
Type: `string`
The output path of the generated files.
### packageJson
Type: `string`
The name of the package.json file
### sourceMap
Default: `true`
Type: `boolean`
Output sourcemaps.
### srcRootForCompilationRoot
Type: `string`
Sets the rootDir for TypeScript compilation. When not defined, it uses the project's root property
### updateBuildableProjectDepsInPackageJson
Default: `true`
Type: `boolean`
Update buildable project dependencies in package.json
### watch
Default: `false`
Type: `boolean`
Enable re-building when files change.