@zuke/turbo

`@zuke/turbo` — typed `TurboTasks` wrappers for the

Symbols

# TurboPruneSettings class

class TurboPruneSettings extends TurboSettings

Settings for turbo prune.

Member	Signature	Doc
`package`	`package(name: string): this`	The package to prune the workspace down to (required).
`docker`	`docker(): this`	Produce a Docker-friendly layout (`--docker`).
`outDir`	`outDir(path: PathLike): this`	Output directory (`--out-dir`).

# TurboRunSettings class

class TurboRunSettings extends TurboSettings

Settings for turbo run.

Member	Signature	Doc
`tasks`	`tasks(...names: string[]): this`	The package.json task(s) to run (positional; at least one required).
`filter`	`filter(pattern: string): this`	Restrict to matching packages (`--filter`); repeatable.
`parallel`	`parallel(): this`	Run tasks in parallel, ignoring dependencies (`--parallel`).
`concurrency`	`concurrency(value: string): this`	Limit concurrency, e.g. `10` or `50%` (`--concurrency`).
`force`	`force(): this`	Ignore cache hits and force execution (`--force`).
`noCache`	`noCache(): this`	Disable reading and writing the cache (`--no-cache`).
`continue`	`continue(): this`	Continue running tasks even after one fails (`--continue`).
`dryRun`	`dryRun(): this`	List what would run without executing (`--dry-run`).
`outputLogs`	`outputLogs(mode: string): this`	Output-log mode, e.g. `full`, `hash-only`, `errors-only` (`--output-logs`).

# TurboSettings class

class TurboSettings extends ToolSettings

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

# TurboTasks const

const TurboTasks: TurboTasksApi

Typed task functions for the turbo CLI.

# TurboTasksApi interface

interface TurboTasksApi

The shape of TurboTasks.

Member	Signature	Doc
`run`	`run(configure?: Configure<TurboRunSettings>): Promise<CommandOutput>`	Run workspace tasks: `turbo run`.
`prune`	`prune(configure?: Configure<TurboPruneSettings>): Promise<CommandOutput>`	Prune the workspace to a package: `turbo prune`.