Skip to main content

Class: SlackCLIProcess

Defined in: cli/cli-process.ts:50

Constructors​

new SlackCLIProcess()​

new SlackCLIProcess(
   command, 
   globalOptions?, 
   commandOptions?): SlackCLIProcess

Defined in: cli/cli-process.ts:66

Parameters​

command​

string[]

globalOptions?​

SlackCLIGlobalOptions

commandOptions?​

SlackCLICommandOptions

Returns​

SlackCLIProcess

Properties​

command​

command: string[];

Defined in: cli/cli-process.ts:54

Description​

The CLI command to invoke

commandOptions​

commandOptions: SlackCLICommandOptions;

Defined in: cli/cli-process.ts:64

Description​

The CLI command-specific options to pass to the command

globalOptions​

globalOptions: SlackCLIGlobalOptions;

Defined in: cli/cli-process.ts:59

Description​

The global CLI options to pass to the command

Methods​

execAsync()​

execAsync(shellOpts?): Promise<ShellProcess>

Defined in: cli/cli-process.ts:82

Parameters​

shellOpts?​

Partial<SpawnOptionsWithoutStdio>

Returns​

Promise<ShellProcess>

Description​

Executes the command asynchronously, returning the process details once the process finishes executing

execAsyncUntilOutputPresent()​

execAsyncUntilOutputPresent(output, shellOpts?): Promise<ShellProcess>

Defined in: cli/cli-process.ts:93

Parameters​

output​

string

shellOpts?​

Partial<SpawnOptionsWithoutStdio>

Returns​

Promise<ShellProcess>

Description​

Executes the command asynchronously, returning the process details once the process finishes executing

execSync()​

execSync(shellOpts?): string

Defined in: cli/cli-process.ts:109

Parameters​

shellOpts?​

Partial<SpawnOptionsWithoutStdio>

Returns​

string

Description​

Executes the command synchronously, returning the process standard output