Interface: IWorkerKernel

@jupyterlite/kernel.IWorkerKernel

An interface for a comlink-based worker kernel

Methods

commClose

commClose(content, parent): Promise<void>

Parameters

Name	Type
content	ICommCloseMsg<"shell" | "iopub">
parent	any

Returns

Promise<void>

Defined in

packages/kernel/src/tokens.ts:194

commInfo

commInfo(content, parent): Promise<ReplyContent<ICommInfoReply>>

Parameters

Name	Type	Description
content	Object	-
content.target_name?	string	The comm target name to filter returned comms
parent	any	-

Returns

Promise<ReplyContent<ICommInfoReply>>

Defined in

packages/kernel/src/tokens.ts:188

commMsg

commMsg(content, parent): Promise<void>

Parameters

Name	Type
content	ICommMsgMsg<"shell" | "iopub">
parent	any

Returns

Promise<void>

Defined in

packages/kernel/src/tokens.ts:193

commOpen

commOpen(content, parent): Promise<void>

Parameters

Name	Type
content	ICommOpenMsg<"shell" | "iopub">
parent	any

Returns

Promise<void>

Defined in

packages/kernel/src/tokens.ts:192

complete

complete(content, parent): Promise<ReplyContent<ICompleteReply>>

Parameters

Name	Type
content	Object
content.code	string
content.cursor_pos	number
parent	any

Returns

Promise<ReplyContent<ICompleteReply>>

Defined in

packages/kernel/src/tokens.ts:176

execute

execute(content, parent): Promise<Object>

Parameters

Name	Type	Description
content	Object	-
content.allow_stdin?	boolean	Whether to allow stdin requests. The default is true.
content.code	string	The code to execute.
content.silent?	boolean	Whether to execute the code as quietly as possible. The default is false.
content.stop_on_error?	boolean	Whether to the abort execution queue on an error. The default is false.
content.store_history?	boolean	Whether to store history of the execution. The default true if silent is False. It is forced to false if silent is true.
content.user_expressions?	JSONObject	A mapping of names to expressions to be evaluated in the kernel’s interactive namespace.
parent	any	-

Returns

Promise<Object>

Defined in

packages/kernel/src/tokens.ts:172

initialize

initialize(options): Promise<void>

Handle any lazy setup activities.

Parameters

Name	Type
options	IOptions

Returns

Promise<void>

Defined in

packages/kernel/src/tokens.ts:171

inputReply

inputReply(content, parent): Promise<void>

Parameters

Name	Type
content	ReplyContent<IInputReply>
parent	any

Returns

Promise<void>

Defined in

packages/kernel/src/tokens.ts:195

inspect

inspect(content, parent): Promise<ReplyContent<IInspectReply>>

Parameters

Name	Type
content	Object
content.code	string
content.cursor_pos	number
content.detail_level	0 | 1
parent	any

Returns

Promise<ReplyContent<IInspectReply>>

Defined in

packages/kernel/src/tokens.ts:180

isComplete

isComplete(content, parent): Promise<ReplyContent<IIsCompleteReplyIncomplete | IIsCompleteReplyOther>>

Parameters

Name	Type
content	Object
content.code	string
parent	any

Returns

Promise<ReplyContent<IIsCompleteReplyIncomplete | IIsCompleteReplyOther>>

Defined in

packages/kernel/src/tokens.ts:184