Skip to main content

@slack/cli-test / SlackCLIProcess

Class: SlackCLIProcess

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

Constructors​

Constructor​

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

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

Parameters​

command​

string[]

globalOptions?​

SlackCLIGlobalOptions

commandOptions?​

SlackCLICommandOptions

Returns​

SlackCLIProcess

Properties​

command​

command: string[];

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

Description​

The CLI command to invoke

commandOptions​

commandOptions: SlackCLICommandOptions | undefined;

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

Description​

The CLI command-specific options to pass to the command

globalOptions​

globalOptions: SlackCLIGlobalOptions | undefined;

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

Description​

The global CLI options to pass to the command

Methods​

execAsync()​

execAsync(shellOpts?): Promise<ShellProcess>;

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

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:92

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:108

Parameters​

shellOpts?​

Partial<SpawnOptionsWithoutStdio>

Returns​

string

Description​

Executes the command synchronously, returning the process standard output