Class Command<O>

The entry point for spawning child processes. It emits the close and error events.

Example

import { Command } from '@tauri-apps/plugin-shell';
const command = Command.create('node');
command.on('close', data => {
  console.log(`command finished with code ${data.code} and signal ${data.signal}`)
});
command.on('error', error => console.error(`command error: "${error}"`));
command.stdout.on('data', line => console.log(`command stdout: "${line}"`));
command.stderr.on('data', line => console.log(`command stderr: "${line}"`));

const child = await command.spawn();
console.log('pid:', child.pid);

Since

2.0.0

Type Parameters

O extends IOPayload

Hierarchy (View Summary)

EventEmitter<CommandEvents>
- Command

Index

Properties

stdout stderr

Methods

addListener removeListener on once off removeAllListeners listenerCount prependListener prependOnceListener create sidecar spawn execute

Properties

`Readonly`stdout

stdout: EventEmitter<OutputEvents<O>> = ...

Event emitter for the stdout. Emits the data event.

`Readonly`stderr

stderr: EventEmitter<OutputEvents<O>> = ...

Event emitter for the stderr. Emits the data event.

Methods

addListener

addListener<N extends keyof CommandEvents>(
eventName: N,
listener: (arg: CommandEvents[N]) => void,
): this
Alias for emitter.on(eventName, listener).
Type Parameters
- N extends keyof CommandEvents
Parameters
- eventName: N
- listener: (arg: CommandEvents[N]) => void
Returns this
Since
2.0.0
Inherited from EventEmitter.addListener
- Defined in index.ts:118

removeListener

removeListener<N extends keyof CommandEvents>(
eventName: N,
listener: (arg: CommandEvents[N]) => void,
): this
Alias for emitter.off(eventName, listener).
Type Parameters
- N extends keyof CommandEvents
Parameters
- eventName: N
- listener: (arg: CommandEvents[N]) => void
Returns this
Since
2.0.0
Inherited from EventEmitter.removeListener
- Defined in index.ts:130

on

on<N extends keyof CommandEvents>(
eventName: N,
listener: (arg: CommandEvents[N]) => void,
): this
Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

Returns a reference to the EventEmitter, so that calls can be chained.
Type Parameters
- N extends keyof CommandEvents
Parameters
- eventName: N
- listener: (arg: CommandEvents[N]) => void
Returns this
Since
2.0.0
Inherited from EventEmitter.on
- Defined in index.ts:147

once

once<N extends keyof CommandEvents>(
eventName: N,
listener: (arg: CommandEvents[N]) => void,
): this
Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

Returns a reference to the EventEmitter, so that calls can be chained.
Type Parameters
- N extends keyof CommandEvents
Parameters
- eventName: N
- listener: (arg: CommandEvents[N]) => void
Returns this
Since
2.0.0
Inherited from EventEmitter.once
- Defined in index.ts:169

off

off<N extends keyof CommandEvents>(
eventName: N,
listener: (arg: CommandEvents[N]) => void,
): this
Removes the all specified listener from the listener array for the event eventName Returns a reference to the EventEmitter, so that calls can be chained.
Type Parameters
- N extends keyof CommandEvents
Parameters
- eventName: N
- listener: (arg: CommandEvents[N]) => void
Returns this
Since
2.0.0
Inherited from EventEmitter.off
- Defined in index.ts:186

removeAllListeners

removeAllListeners<N extends keyof CommandEvents>(event?: N): this
Removes all listeners, or those of the specified eventName.

Returns a reference to the EventEmitter, so that calls can be chained.
Type Parameters
- N extends keyof CommandEvents
Parameters
- Optionalevent: N
Returns this
Since
2.0.0
Inherited from EventEmitter.removeAllListeners
- Defined in index.ts:206

listenerCount

listenerCount<N extends keyof CommandEvents>(eventName: N): number
Returns the number of listeners listening to the event named eventName.
Type Parameters
- N extends keyof CommandEvents
Parameters
- eventName: N
Returns number
Since
2.0.0
Inherited from EventEmitter.listenerCount
- Defined in index.ts:241

prependListener

prependListener<N extends keyof CommandEvents>(
eventName: N,
listener: (arg: CommandEvents[N]) => void,
): this
Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

Returns a reference to the EventEmitter, so that calls can be chained.
Type Parameters
- N extends keyof CommandEvents
Parameters
- eventName: N
- listener: (arg: CommandEvents[N]) => void
Returns this
Since
2.0.0
Inherited from EventEmitter.prependListener
- Defined in index.ts:258

prependOnceListener

prependOnceListener<N extends keyof CommandEvents>(
eventName: N,
listener: (arg: CommandEvents[N]) => void,
): this
Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

Returns a reference to the EventEmitter, so that calls can be chained.
Type Parameters
- N extends keyof CommandEvents
Parameters
- eventName: N
- listener: (arg: CommandEvents[N]) => void
Returns this
Since
2.0.0
Inherited from EventEmitter.prependOnceListener
- Defined in index.ts:280

`Static`create

create(program: string, args?: string | string[]): Command<string>
Parameters
- program: string
- Optionalargs: string | string[]
Returns Command<string>
- Defined in index.ts:406
create(
    program: string,
    args?: string | string[],
    options?: SpawnOptions & { encoding: "raw" },
): Command<Uint8Array<ArrayBufferLike>>
Parameters
- program: string
- Optionalargs: string | string[]
- Optionaloptions: SpawnOptions & { encoding: "raw" }
Returns Command<Uint8Array<ArrayBufferLike>>
- Defined in index.ts:407
create(
    program: string,
    args?: string | string[],
    options?: SpawnOptions,
): Command<string>
Parameters
- program: string
- Optionalargs: string | string[]
- Optionaloptions: SpawnOptions
Returns Command<string>
- Defined in index.ts:412

`Static`sidecar

sidecar(program: string, args?: string | string[]): Command<string>
Parameters
- program: string
- Optionalargs: string | string[]
Returns Command<string>
- Defined in index.ts:438
sidecar(
    program: string,
    args?: string | string[],
    options?: SpawnOptions & { encoding: "raw" },
): Command<Uint8Array<ArrayBufferLike>>
Parameters
- program: string
- Optionalargs: string | string[]
- Optionaloptions: SpawnOptions & { encoding: "raw" }
Returns Command<Uint8Array<ArrayBufferLike>>
- Defined in index.ts:439
sidecar(
    program: string,
    args?: string | string[],
    options?: SpawnOptions,
): Command<string>
Parameters
- program: string
- Optionalargs: string | string[]
- Optionaloptions: SpawnOptions
Returns Command<string>
- Defined in index.ts:444

spawn

spawn(): Promise<Child>
Executes the command as a child process, returning a handle to it.

Returns Promise<Child>
A promise resolving to the child process handle.

Since
2.0.0
- Defined in index.ts:479

execute

execute(): Promise<ChildProcess<O>>

Executes the command as a child process, waiting for it to finish and collecting all of its output.

Returns Promise<ChildProcess<O>>

A promise resolving to the child process output.

Example

import { Command } from '@tauri-apps/plugin-shell';
const output = await Command.create('echo', 'message').execute();
assert(output.code === 0);
assert(output.signal === null);
assert(output.stdout === 'message');
assert(output.stderr === '');

Since

2.0.0

Class Command<O>

Example

Since

Type Parameters

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Readonlystdout

Readonlystderr

Methods

addListener

Type Parameters

Parameters

Returns this

Since

removeListener

Type Parameters

Parameters

Returns this

Since

on

Type Parameters

Parameters

Returns this

Since

once

Type Parameters

Parameters

Returns this

Since

off

Type Parameters

Parameters

Returns this

Since

removeAllListeners

Type Parameters

Parameters

Returns this

Since

listenerCount

Type Parameters

Parameters

Returns number

Since

prependListener

Type Parameters

Parameters

Returns this

Since

prependOnceListener

Type Parameters

Parameters

Returns this

Since

Staticcreate

Parameters

Returns Command<string>

Parameters

Returns Command<Uint8Array<ArrayBufferLike>>

Parameters

Returns Command<string>

Staticsidecar

Parameters

Returns Command<string>

Parameters

Returns Command<Uint8Array<ArrayBufferLike>>

Parameters

Returns Command<string>

spawn

Returns Promise<Child>

Since

execute

Returns Promise<ChildProcess<O>>

Example

Since

Settings

On This Page

`Readonly`stdout

`Readonly`stderr

`Static`create

`Static`sidecar