Global

Members

context :Context

Script context
Type:
Source:

kernel :module:child_process~ChildProcess

Kernel instance
Type:
  • module:child_process~ChildProcess
Source:

onMessage :onMessageCallback

Callback to handle kernel messages
Type:
Source:

Methods

dispose()

Dispose the messaging test engine
Source:

init(done)

Initialise the messaging test engine
Parameters:
Name Type Description
done function
Source:

parseCommandArguments() → {module:jp-kernel~Config}

Parse command arguments
Source:
Returns:
Kernel config
Type
module:jp-kernel~Config

run(code, onMessageopt) → {Message}

Send kernel an execution request
Parameters:
Name Type Attributes Description
code string Code to be run by kernel
onMessage onMessageCallback <optional>
 Kernel message handler
Source:
Returns:
message IPython/Jupyter message
Type
Message

Type Definitions

Context

Properties:
Name Type Description
context
Properties
Name Type Description
path
Properties
Name Type Description
node String Path to Node.js shell
root String Path to CoffeeScript root folder
kernel String Path to CoffeeScript kernel
images String Path to CoffeeScript images folder
packageJSON Object Contents of npm package.json
flag
Properties
Name Type Description
debug Boolean -debug
hideUndefined Boolean -[hide|show]-undefined
install String -install=[local|global]
specPath String -spec-path=[none|full]
startup String -startup-script=path
cwd String -working-dir=path
args
Properties
Name Type Description
kernel Array.<String> Command arguments to run kernel
frontend Array.<String> Command arguments to run frontend
protocol
Properties
Name Type Description
version String Protocol version
majorVersion Integer Protocol major version
frontend
Properties
Name Type Description
error Error Frontend error
version String Frontend version
majorVersion Integer Frontend major version
Source:

Message

IPython/Jupyter message
Type:
  • Object
Properties:
Name Type Attributes Description
message.idents Array <optional>
 Identities
message.header Object <optional>
 Header
message.parent_header Object <optional>
 Parent header
message.metadata Object <optional>
 Message metadata
message.content Object <optional>
 Message content
Source:

onMessageCallback(socketName, message)

Callback to handle kernel messages
Parameters:
Name Type Description
socketName string Socket name
message Message IPython/Jupyter message
Source: