@zuke/nx

← API reference

`@zuke/nx` — typed `NxTasks` wrappers for the [Nx](https://nx.dev) CLI, for

Symbols

# NxAffectedSettings class
class NxAffectedSettings extends NxSettings

Settings for nx affected.

MemberSignatureDoc
target target(name: string): this The target to run on affected projects (required).
base base(ref: string): this The base ref to diff against (--base).
head head(ref: string): this The head ref to diff against (--head).
configuration configuration(name: string): this Use a named configuration (--configuration).
parallel parallel(count: number): this Maximum number of tasks to run in parallel (--parallel).
# NxRunManySettings class
class NxRunManySettings extends NxSettings

Settings for nx run-many.

MemberSignatureDoc
target target(name: string): this The target to run across projects (required).
projects projects(...names: string[]): this Limit to specific projects (--projects); repeatable.
configuration configuration(name: string): this Use a named configuration (--configuration).
parallel parallel(count: number): this Maximum number of tasks to run in parallel (--parallel).
all all(): this Run for every project (--all).
# NxRunSettings class
class NxRunSettings extends NxSettings

Settings for nx run (a single project:target).

MemberSignatureDoc
target target(spec: string): this The project:target to run, e.g. web:build (required).
configuration configuration(name: string): this Use a named configuration (--configuration).
# NxSettings class
class NxSettings extends ToolSettings

Base for all nx subcommand settings: the binary is nx.

# NxTasks const
const NxTasks: NxTasksApi

Typed task functions for the nx CLI.

# NxTasksApi interface
interface NxTasksApi

The shape of NxTasks.

MemberSignatureDoc
run run(configure?: Configure<NxRunSettings>): Promise<CommandOutput> Run a single project:target: nx run.
runMany runMany(configure?: Configure<NxRunManySettings>): Promise<CommandOutput> Run a target across many projects: nx run-many.
affected affected(configure?: Configure<NxAffectedSettings>): Promise<CommandOutput> Run a target on affected projects: nx affected.