nx/docs/generated/devkit/TargetConfiguration.md
Emily Xiong 39e104b6c3
feat(core): add parallelism to target configuration (#26820)
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #
2024-07-12 16:35:45 -04:00

2.5 KiB

Interface: TargetConfiguration<T>

Target's configuration

Type parameters

Name Type
T any

Table of contents

Properties

Properties

cache

Optional cache: boolean

Determines if Nx is able to cache a given target.


command

Optional command: string

Used as a shorthand for nx:run-commands, a command to run.


configurations

Optional configurations: Object

Sets of options

Index signature

▪ [config: string]: any


defaultConfiguration

Optional defaultConfiguration: string

A default named configuration to use when a target configuration is not provided.


dependsOn

Optional dependsOn: (string | TargetDependencyConfig)[]

This describes other targets that a target depends on.


executor

Optional executor: string

The executor/builder used to implement the target.

Example: '@nx/rollup:rollup'


inputs

Optional inputs: (string | InputDefinition)[]

This describes filesets, runtime dependencies and other inputs that a target depends on.


metadata

Optional metadata: TargetMetadata

Metadata about the target


options

Optional options: T

Target's options. They are passed in to the executor.


outputs

Optional outputs: string[]

List of the target's outputs. The outputs will be cached by the Nx computation caching engine.


parallelism

Optional parallelism: boolean

Whether this target can be run in parallel with other tasks Default is true