Search
Preparing search index...
The search index is not available
Unraid API Client - v0.17.0
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Unraid API Client - v0.17.0
Executor
Class Executor<Config>
Type parameters
Config
Hierarchy
Executor
SSHExecutor
Index
Constructors
constructor
Properties
config
Methods
execute
execute
Stream
Constructors
constructor
new
Executor
<
Config
>
(
config
:
Config
)
:
Executor
<
Config
>
Type parameters
Config
:
ExecutorConfigType
=
ExecutorConfigType
Parameters
config:
Config
Returns
Executor
<
Config
>
Properties
Readonly
config
config
:
Config
Methods
Abstract
execute
execute
(
command
:
string
)
:
Promise
<
IExecuteResult
>
execute
(
__namedParameters
:
IExecute
)
:
Promise
<
IExecuteResult
>
execute
(
command
:
string
|
IExecute
)
:
Promise
<
IExecuteResult
>
Parameters
command:
string
Returns
Promise
<
IExecuteResult
>
Parameters
__namedParameters:
IExecute
Returns
Promise
<
IExecuteResult
>
Parameters
command:
string
|
IExecute
Returns
Promise
<
IExecuteResult
>
Optional
execute
Stream
execute
Stream
(
command
:
string
|
IExecute
)
:
Promise
<
[
EventEmitter
,
CancelFunction
,
Promise
<
IExecuteStreamResult
>
]
>
Parameters
command:
string
|
IExecute
Returns
Promise
<
[
EventEmitter
,
CancelFunction
,
Promise
<
IExecuteStreamResult
>
]
>
Exports
Executor
constructor
config
execute
execute
Stream
Generated using
TypeDoc