Module child_process

Interfaces

ChildProcess

Methods

SM exec(command: string, options: module:child_process.ExecOptionsType, callback: module:child_process.ExecCallbackCallback) child_process.ChildProcess

Parameters:
Name Type Argument
command string
options module:child_process.ExecOptionsType
callback module:child_process.ExecCallbackCallback <optional>
Returns: { child_process.ChildProcess }

SM exec(command: string, callback: module:child_process.ExecCallbackCallback) child_process.ChildProcess

Parameters:
Name Type Argument
command string
callback module:child_process.ExecCallbackCallback <optional>
Returns: { child_process.ChildProcess }

SM execFile(file: string, callback: module:child_process.ExecFileCallbackCallback) child_process.ChildProcess

Parameters:
Name Type Argument
file string
callback module:child_process.ExecFileCallbackCallback <optional>
Returns: { child_process.ChildProcess }

SM execFile(file: string, args: string[], callback: module:child_process.ExecFileCallbackCallback) child_process.ChildProcess

Parameters:
Name Type Argument
file string
args Array.<string> <optional>
callback module:child_process.ExecFileCallbackCallback <optional>
Returns: { child_process.ChildProcess }

SM execFile(file: string, args: string[], options: module:child_process.ExecFileOptionsType, callback: module:child_process.ExecFileCallbackCallback) child_process.ChildProcess

Parameters:
Name Type Argument
file string
args Array.<string> <optional>
options module:child_process.ExecFileOptionsType <optional>
callback module:child_process.ExecFileCallbackCallback <optional>
Returns: { child_process.ChildProcess }

SM execFileSync(command: string, args: string[], options: module:child_process.ExecFileSyncOptionsType) child_process.ChildProcess

Parameters:
Name Type Argument
command string
args Array.<string> <optional>
options module:child_process.ExecFileSyncOptionsType <optional>
Returns: { child_process.ChildProcess }

SM execSync(command: string, options: module:child_process.ExecSyncOptionsType) child_process.ChildProcess

Parameters:
Name Type Argument
command string
options module:child_process.ExecSyncOptionsType <optional>
Returns: { child_process.ChildProcess }

SM fork(modulePath: string, args: string[], options: module:child_process.ForkOptionsType) child_process.ChildProcess

Parameters:
Name Type Argument
modulePath string
args Array.<string> <optional>
options module:child_process.ForkOptionsType <optional>
Returns: { child_process.ChildProcess }

SM spawn(command: string, args: string[], options: module:child_process.SpawnOptionsType) child_process.ChildProcess

Parameters:
Name Type Argument
command string
args Array.<string> <optional>
options module:child_process.SpawnOptionsType <optional>
Returns: { child_process.ChildProcess }

Callbacks

ExecCallbackCallback(error: Error, stdout: Buffer, stderr: Buffer) void

Parameters:
Name Type
error Error
stdout Buffer
stderr Buffer
Returns: { void }

ExecCallbackCallback(error: Error, stdout: Buffer, stderr: Buffer) void

Parameters:
Name Type
error Error
stdout Buffer
stderr Buffer
Returns: { void }

ExecFileCallbackCallback(error: Error, stdout: Buffer, stderr: Buffer) void

Parameters:
Name Type
error Error
stdout Buffer
stderr Buffer
Returns: { void }

ExecFileCallbackCallback(error: Error, stdout: Buffer, stderr: Buffer) void

Parameters:
Name Type
error Error
stdout Buffer
stderr Buffer
Returns: { void }

ExecFileCallbackCallback(error: Error, stdout: Buffer, stderr: Buffer) void

Parameters:
Name Type
error Error
stdout Buffer
stderr Buffer
Returns: { void }

Type Definitions

T ExecFileOptionsType

Type:
  • Object
Properties:
Name Type
cwd string
stdio any
customFds any
env any
encoding string
timeout number
maxBuffer string
killSignal string

T ExecFileSyncOptionsType

Type:
  • Object
Properties:
Name Type
cwd string
input string | Buffer
stdio any
env any
uid number
gid number
timeout number
maxBuffer number
killSignal string
encoding string

T ExecOptionsType

Type:
  • Object
Properties:
Name Type
cwd string
stdio any
customFds any
env any
encoding string
timeout number
maxBuffer number
killSignal string

T ExecSyncOptionsType

Type:
  • Object
Properties:
Name Type
cwd string
input string | Buffer
stdio any
env any
uid number
gid number
timeout number
maxBuffer number
killSignal string
encoding string

T ForkOptionsType

Type:
  • Object
Properties:
Name Type
cwd string
env any
encoding string

T SpawnOptionsType

Type:
  • Object
Properties:
Name Type
cwd string
stdio any
custom any
env any
detached boolean