@zuke/npx

← API reference

`@zuke/npx` — typed `NpxTasks` wrappers for the `npx` package runner, for use

Symbols

# NpxSettings class
class NpxSettings extends ToolSettings

Settings for the npx package runner.

MemberSignatureDoc
command command(name: string): this The package binary to execute (required unless call is set).
package package(...specs: string[]): this Packages to load before running (--package=); repeatable.
call call(script: string): this Execute a string as if inside npm run-script (--call).
yes yes(): this Auto-install a missing package without prompting (--yes).
no no(): this Never auto-install; fail if the package is missing (--no).
ignoreExisting ignoreExisting(): this Ignore binaries already present in $PATH (--ignore-existing).
execArgs execArgs(...args: Array<string | number>): this Arguments forwarded to the command.
# NpxTasks const
const NpxTasks: NpxTasksApi

Typed task functions for the npx package runner.

# NpxTasksApi interface
interface NpxTasksApi

The shape of NpxTasks.

MemberSignatureDoc
npx npx(configure?: Configure<NpxSettings>): Promise<CommandOutput> Download and execute a package binary: npx <command>.