Class CliUtils

CLI utilities, useful to run commands.

Constructors

constructor

Accessors

shelljs shelljsSafeExec spawn spawnSync

Constructors

constructor

Accessors

shelljs

shelljsSafeExec

  • get shelljsSafeExec(): ((command, errorMessage?) => ShellString)

  • Function that executes a command using shelljs. If the exit code is not 0 it throws an exception.

    Returns ((command, errorMessage?) => ShellString)

      • (command, errorMessage?): ShellString

      • Parameters

        • command: string
        • Optional errorMessage: string

        Returns ShellString

spawn

  • get spawn(): ((command, params?) => Promise<null | number>)

  • Function that executes a command using javascript spawn. The result is a resolved promise when the exit code is 0, otherwise it is a rejected promise.

    Returns ((command, params?) => Promise<null | number>)

      • (command, params?): Promise<null | number>

      • Parameters

        • command: string
        • Optional params: string[]

        Returns Promise<null | number>

spawnSync

  • get spawnSync(): ((command, params?) => SpawnSyncReturns<Buffer>)

  • Function that executes a command using javascript spawnSync. The result is a resolved promise when the exit code is 0, otherwise it is a rejected promise.

    Returns ((command, params?) => SpawnSyncReturns<Buffer>)

      • (command, params?): SpawnSyncReturns<Buffer>

      • Parameters

        • command: string
        • Optional params: string[]

        Returns SpawnSyncReturns<Buffer>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc