@jupyterlite / @jupyterlite/services / IWorkerKernel
Interface: IWorkerKernel#
Defined in: packages/services/src/kernel/tokens.ts:173
An interface for a comlink-based worker kernel
Methods#
commClose()#
commClose(
content,parent):Promise<void>
Defined in: packages/services/src/kernel/tokens.ts:200
Parameters#
content#
ICommCloseMsg
parent#
any
Returns#
Promise<void>
commInfo()#
commInfo(
content,parent):Promise<ReplyContent<ICommInfoReply>>
Defined in: packages/services/src/kernel/tokens.ts:194
Parameters#
content#
target_name?#
string
The comm target name to filter returned comms
parent#
any
Returns#
Promise<ReplyContent<ICommInfoReply>>
commMsg()#
commMsg(
content,parent):Promise<void>
Defined in: packages/services/src/kernel/tokens.ts:199
Parameters#
content#
ICommMsgMsg
parent#
any
Returns#
Promise<void>
commOpen()#
commOpen(
content,parent):Promise<void>
Defined in: packages/services/src/kernel/tokens.ts:198
Parameters#
content#
ICommOpenMsg
parent#
any
Returns#
Promise<void>
complete()#
complete(
content,parent):Promise<ReplyContent<ICompleteReply>>
Defined in: packages/services/src/kernel/tokens.ts:182
Parameters#
content#
code#
string
cursor_pos#
number
parent#
any
Returns#
Promise<ReplyContent<ICompleteReply>>
execute()#
execute(
content,parent):Promise<ReplyContent<IExecuteReply> &IExecuteCount>
Defined in: packages/services/src/kernel/tokens.ts:178
Parameters#
content#
allow_stdin?#
boolean
Whether to allow stdin requests.
The default is true.
code#
string
The code to execute.
silent?#
boolean
Whether to execute the code as quietly as possible.
The default is false.
stop_on_error?#
boolean
Whether to the abort execution queue on an error.
The default is false.
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.
user_expressions?#
JSONObject
A mapping of names to expressions to be evaluated in the kernel’s interactive namespace.
parent#
any
Returns#
Promise<ReplyContent<IExecuteReply> & IExecuteCount>
initialize()#
initialize(
options):Promise<void>
Defined in: packages/services/src/kernel/tokens.ts:177
Handle any lazy setup activities.
Parameters#
options#
Returns#
Promise<void>
inputReply()#
inputReply(
content,parent):Promise<void>
Defined in: packages/services/src/kernel/tokens.ts:201
Parameters#
content#
ReplyContent<IInputReply>
parent#
any
Returns#
Promise<void>
inspect()#
inspect(
content,parent):Promise<ReplyContent<IInspectReply>>
Defined in: packages/services/src/kernel/tokens.ts:186
Parameters#
content#
code#
string
cursor_pos#
number
detail_level#
0 | 1
parent#
any
Returns#
Promise<ReplyContent<IInspectReply>>
isComplete()#
isComplete(
content,parent):Promise<ReplyContent<IIsCompleteReplyIncomplete|IIsCompleteReplyOther>>
Defined in: packages/services/src/kernel/tokens.ts:190
Parameters#
content#
code#
string
parent#
any
Returns#
Promise<ReplyContent<IIsCompleteReplyIncomplete | IIsCompleteReplyOther>>