mirror of https://github.com/embarklabs/embark.git
Add api docs for console module
parent
09477da848
commit
b96d83b73f
|
@ -1,7 +1,7 @@
|
|||
|
||||
**Core**
|
||||
* [code-runner](#code-runner)
|
||||
* console
|
||||
* [console](#console)
|
||||
* core
|
||||
* engine
|
||||
* i18n
|
||||
|
@ -241,6 +241,40 @@ starts a communication node according to the config given. will start one of the
|
|||
|
||||
* `communication:started` - emitted when communication node starts
|
||||
|
||||
### console
|
||||
|
||||
module type: core component
|
||||
|
||||
#### Description
|
||||
Component that enables interactive console capabilities in the Embark command line interface as well as graphical user interfaces such as Cockpit.
|
||||
|
||||
#### API
|
||||
|
||||
##### requests
|
||||
|
||||
name: `console:register:helpCmd`
|
||||
arguments:
|
||||
* `cmdOptions` {object} - Configuration object for help command to be registered
|
||||
* `helpCmd` {string} - Command to be executed as help command
|
||||
* `cmdName` {string} - Name of help command
|
||||
* `cb` {function} - Callback to be called when help command registration is done
|
||||
|
||||
Registers a help command with the console.
|
||||
|
||||
name `console:unregister:helpCmd`
|
||||
arguments:
|
||||
* `cmdName` {string} - Name of help command
|
||||
|
||||
Deregisters help command from the console.
|
||||
|
||||
name: `console:executeCmd`
|
||||
arguments:
|
||||
* `cmd` {string} - Command to be executed
|
||||
* `cb` {function} - Callback to be called when command finished execution
|
||||
|
||||
Executes a given command in Embark virtual machine.
|
||||
a
|
||||
|
||||
### whisper
|
||||
|
||||
module type: plugin
|
||||
|
|
Loading…
Reference in New Issue