@jupyterlite


@jupyterlite / @jupyterlite/services / IRemoteKernel

Interface: IRemoteKernel#

Defined in: packages/services/src/kernel/tokens.ts:222

Extends#

Properties#

[createEndpoint]()#

[createEndpoint]: () => Promise<MessagePort>

Defined in: node_modules/comlink/dist/umd/comlink.d.ts:86

Returns#

Promise<MessagePort>

Inherited from#

Remote.[createEndpoint]


[releaseProxy]()#

[releaseProxy]: () => void

Defined in: node_modules/comlink/dist/umd/comlink.d.ts:87

Returns#

void

Inherited from#

Remote.[releaseProxy]

Methods#

commClose()#

commClose(…args): Promise<void>

Defined in: packages/services/src/kernel/tokens.ts:200

Parameters#

args#

…[ICommCloseMsg<"iopub" | "shell">, any]

Returns#

Promise<void>

Inherited from#

Remote.commClose


commInfo()#

commInfo(…args): Promise<IReplyErrorContent> | Promise<IReplyAbortContent> | Promise<ICommInfoReply>

Defined in: packages/services/src/kernel/tokens.ts:194

Parameters#

args#

…[object, any]

Returns#

Promise<IReplyErrorContent> | Promise<IReplyAbortContent> | Promise<ICommInfoReply>

Inherited from#

Remote.commInfo


commMsg()#

commMsg(…args): Promise<void>

Defined in: packages/services/src/kernel/tokens.ts:199

Parameters#

args#

…[ICommMsgMsg<"iopub" | "shell">, any]

Returns#

Promise<void>

Inherited from#

Remote.commMsg


commOpen()#

commOpen(…args): Promise<void>

Defined in: packages/services/src/kernel/tokens.ts:198

Parameters#

args#

…[ICommOpenMsg<"iopub" | "shell">, any]

Returns#

Promise<void>

Inherited from#

Remote.commOpen


complete()#

complete(…args): Promise<IReplyErrorContent> | Promise<IReplyAbortContent> | Promise<ICompleteReply>

Defined in: packages/services/src/kernel/tokens.ts:182

Parameters#

args#

…[object, any]

Returns#

Promise<IReplyErrorContent> | Promise<IReplyAbortContent> | Promise<ICompleteReply>

Inherited from#

Remote.complete


execute()#

execute(…args): Promise<IReplyErrorContent & IExecuteCount> | Promise<IReplyAbortContent & IExecuteCount> | Promise<IExecuteReply & IExecuteCount>

Defined in: packages/services/src/kernel/tokens.ts:178

Parameters#

args#

…[object, any]

Returns#

Promise<IReplyErrorContent & IExecuteCount> | Promise<IReplyAbortContent & IExecuteCount> | Promise<IExecuteReply & IExecuteCount>

Inherited from#

Remote.execute


initialize()#

initialize(…args): Promise<void>

Defined in: packages/services/src/kernel/tokens.ts:177

Parameters#

args#

…[IOptions]

Returns#

Promise<void>

Inherited from#

Remote.initialize


inputReply()#

inputReply(…args): Promise<void>

Defined in: packages/services/src/kernel/tokens.ts:201

Parameters#

args#

…[ReplyContent<IInputReply>, any]

Returns#

Promise<void>

Inherited from#

Remote.inputReply


inspect()#

inspect(…args): Promise<IReplyErrorContent> | Promise<IReplyAbortContent> | Promise<IInspectReply>

Defined in: packages/services/src/kernel/tokens.ts:186

Parameters#

args#

…[object, any]

Returns#

Promise<IReplyErrorContent> | Promise<IReplyAbortContent> | Promise<IInspectReply>

Inherited from#

Remote.inspect


isComplete()#

isComplete(…args): Promise<IReplyErrorContent> | Promise<IReplyAbortContent> | Promise<IIsCompleteReplyIncomplete> | Promise<IIsCompleteReplyOther>

Defined in: packages/services/src/kernel/tokens.ts:190

Parameters#

args#

…[object, any]

Returns#

Promise<IReplyErrorContent> | Promise<IReplyAbortContent> | Promise<IIsCompleteReplyIncomplete> | Promise<IIsCompleteReplyOther>

Inherited from#

Remote.isComplete