thebe-core / Exports

Table of contents

Enumerations

Classes

Interfaces

Type Aliases

Variables

JS Bundle API Functions

Other Functions

Type Aliases

EventObject

Ƭ EventObject: ThebeServer | ThebeSession | ThebeNotebook | ThebeCell

Defined in

packages/core/src/events.ts:73


JsonObject

Ƭ JsonObject: Record<string, any>

Defined in

packages/core/src/types.ts:8


KernelISpecModel

Ƭ KernelISpecModel: KernelSpecAPI.ISpecModel

Defined in

packages/core/src/types.ts:11


KernelISpecModels

Ƭ KernelISpecModels: KernelSpecAPI.ISpecModels

Defined in

packages/core/src/types.ts:10


MathjaxOptions

Ƭ MathjaxOptions: Pick<CoreOptions, "mathjaxConfig" | "mathjaxUrl">

Defined in

packages/core/src/types.ts:49


SessionIModel

Ƭ SessionIModel: Session.IModel

Defined in

packages/core/src/types.ts:9


StatusEvent

Ƭ StatusEvent: ServerStatusEvent | SessionStatusEvent | NotebookStatusEvent | CellStatusEvent | KernelStatusEvent | ErrorStatusEvent

Defined in

packages/core/src/events.ts:75


ThebeCore

Ƭ ThebeCore: typeof thebe-core

Defined in

packages/core/src/thebe/entrypoint.ts:33


ThebeEventCb

Ƭ ThebeEventCb: (event: string, data: ThebeEventData) => void

Type declaration

▸ (event, data): void

Parameters
NameType
eventstring
dataThebeEventData
Returns

void

Defined in

packages/core/src/events.ts:91

Variables

WIDGET_MIMETYPE

Const WIDGET_MIMETYPE: "application/vnd.jupyter.widget-view+json"

Defined in

packages/core/src/manager.ts:21

JS Bundle API Functions

connect

connect(config): ThebeServer

Parameters

NameType
configConfig

Returns

ThebeServer

ThebeServer

Defined in

packages/core/src/thebe/api.ts:16


Other Functions

ensureCoreOptions

ensureCoreOptions(options, events?): Required<CoreOptions>

Parameters

NameType
optionsCoreOptions & { [k: string]: any; }
events?ThebeEvents

Returns

Required<CoreOptions>

Defined in

packages/core/src/options.ts:65


ensureString

ensureString(maybeString): string

Parameters

NameType
maybeStringstring | string[]

Returns

string

Defined in

packages/core/src/utils.ts:14


errorToMessage

errorToMessage(json): string

Parameters

NameType
jsonIError

Returns

string

Defined in

packages/core/src/events.ts:58


getRenderMimeRegistry

getRenderMimeRegistry(mathjax?): RenderMimeRegistry

Parameters

NameType
mathjax?MathjaxOptions

Returns

RenderMimeRegistry

Defined in

packages/core/src/rendermime.ts:58


getRenderers

getRenderers(mathjax): Object

Parameters

NameType
mathjaxMathjaxOptions

Returns

Object

NameType
initialFactoriesIRendererFactory[]
latexTypesetterundefined | MathJaxTypesetter

Defined in

packages/core/src/rendermime.ts:29


makeBinderOptions

makeBinderOptions(opts): Object

Parameters

NameType
optsBinderOptions

Returns

Object

NameType
binderUrlstring
refstring
repostring
repoProviderRepoProvider

Defined in

packages/core/src/options.ts:13


makeConfiguration

makeConfiguration(options, events?): Config

Parameters

NameType
optionsCoreOptions & { [k: string]: any; }
events?ThebeEvents

Returns

Config

Defined in

packages/core/src/options.ts:58


makeKernelOptions

makeKernelOptions(opts): Object

Parameters

NameType
optsKernelOptions

Returns

Object

NameType
kernelNamestring
namestring
pathstring

Defined in

packages/core/src/options.ts:32


makeMathjaxOptions

makeMathjaxOptions(opts?): Object

Parameters

NameType
opts?MathjaxOptions

Returns

Object

NameType
mathjaxConfigstring
mathjaxUrlstring

Defined in

packages/core/src/options.ts:50


makeSavedSessionOptions

makeSavedSessionOptions(opts): Object

Parameters

NameType
optsSavedSessionOptions

Returns

Object

NameType
enabledboolean
maxAgenumber
storagePrefixstring

Defined in

packages/core/src/options.ts:23


makeServerSettings

makeServerSettings(settings): Object

Parameters

NameType
settingsServerSettings

Returns

Object

NameType
appendTokenboolean
baseUrlstring
tokenstring
wsUrl?string

Defined in

packages/core/src/options.ts:41


setupNotebook

setupNotebook(blocks, options, events): ThebeNotebook

Parameters

NameType
blocksCodeBlock[]
optionsCoreOptions
eventsThebeEvents

Returns

ThebeNotebook

Defined in

packages/core/src/thebe/api.ts:34


setupThebeCore

setupThebeCore(): void

Returns

void

Defined in

packages/core/src/thebe/api.ts:43


shortId

shortId(): string

Creates a compact random id for use in runtime objects

Returns

string

string

Defined in

packages/core/src/utils.ts:10