Class Builder

Builder functions map

Hierarchy

Builder

Index

Constructors

Methods

bin decorateArgs decorateEnv script

Constructors

constructor

new Builder(): Builder
Returns Builder

Methods

bin

bin<Bin>(bin, next?): BinScriptDef<Bin>
Builds a script definition for a binary.
Type Parameters
- Bin extends string
Parameters
- bin: Bin
  The binary to run
- Optional next: NextDef
  Options to pass to the next script
Returns BinScriptDef<Bin>
The script definition
- Defined in index.ts:551

decorateArgs

decorateArgs<Args>(args): InjectArgsDef<Args>
Decorates the arguments passed to the next script.
Type Parameters
- Args extends string[] = string[]
Parameters
- args: ((args) => Promiseable<Args>)
  Async callback that receives the accumulated arguments
  - - (args): Promiseable<Args>
    - Parameters
      args: string[]
      Returns Promiseable<Args>
Returns InjectArgsDef<Args>
The decorated arguments
- Defined in index.ts:538

decorateEnv

decorateEnv<Env>(env): InjectEnvDef<Env>
Decorates the environment variables passed to the next script.
Type Parameters
- Env extends ScriptEnv = ScriptEnv
Parameters
- env: ((env) => Promiseable<Env>)
  Async callback that receives the accumulated environment variables
  - - (env): Promiseable<Env>
    - Parameters
      env: ProcessEnv
      Returns Promiseable<Env>
Returns InjectEnvDef<Env>
The decorated environment variables
- Defined in index.ts:527

script

script<Script>(script, next?): ScriptDef<Script>
Builds a script definition.
Type Parameters
- Script extends string
Parameters
- script: Script
  The script path
- Optional next: NextDef
  Options to pass to the next script
Returns ScriptDef<Script>
The script definition
- Defined in index.ts:562

Generated using TypeDoc