Interface: IWorkerKernel#

kernel.IWorkerKernel

An interface for a comlink-based worker kernel

Hierarchy#

Methods#

commClose#

commClose(content, parent): Promise<void>

Parameters#

Name

Type

content

ICommCloseMsg<"iopub" | "shell">

parent

any

Returns#

Promise<void>

Defined in#

packages/kernel/lib/tokens.d.ts:137


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/lib/tokens.d.ts:134


commMsg#

commMsg(content, parent): Promise<void>

Parameters#

Name

Type

content

ICommMsgMsg<"iopub" | "shell">

parent

any

Returns#

Promise<void>

Defined in#

packages/kernel/lib/tokens.d.ts:136


commOpen#

commOpen(content, parent): Promise<void>

Parameters#

Name

Type

content

ICommOpenMsg<"iopub" | "shell">

parent

any

Returns#

Promise<void>

Defined in#

packages/kernel/lib/tokens.d.ts:135


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/lib/tokens.d.ts:131


execute#

execute(content, parent): Promise<IReplyErrorContent & IExecuteCount & IReplyAbortContent & IExecuteCount & IExecuteReply & IExecuteCount>

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<IReplyErrorContent & IExecuteCount & IReplyAbortContent & IExecuteCount & IExecuteReply & IExecuteCount>

Defined in#

packages/kernel/lib/tokens.d.ts:130


initialize#

initialize(options): Promise<void>

Handle any lazy setup activities.

Parameters#

Name

Type

options

IOptions

Returns#

Promise<void>

Defined in#

packages/kernel/lib/tokens.d.ts:129


inputReply#

inputReply(content, parent): Promise<void>

Parameters#

Name

Type

content

ReplyContent<IInputReply>

parent

any

Returns#

Promise<void>

Defined in#

packages/kernel/lib/tokens.d.ts:138


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/lib/tokens.d.ts:132


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/lib/tokens.d.ts:133