thebe-core
thebe-core / Exports
#Table of contents
#Enumerations
- CellStatusEvent
- ErrorStatusEvent
- EventSubject
- KernelStatusEvent
- NotebookStatusEvent
- RepoProvider
- ServerStatusEvent
- SessionStatusEvent
- ThebeEventType
#Classes
#Interfaces
- BinderOptions
- CodeBlock
- CoreOptions
- IPassiveCell
- IThebeCell
- IThebeCellExecuteReturn
- JsApi
- KernelOptions
- RestAPIContentsResponse
- SavedSessionInfo
- SavedSessionOptions
- ServerInfo
- ServerRestAPI
- ServerRuntime
- ServerSettings
- ThebeCoreGlobal
- ThebeEventData
#Type Aliases
- EventObject
- JsonObject
- KernelISpecModel
- KernelISpecModels
- MathjaxOptions
- SessionIModel
- StatusEvent
- ThebeCore
- ThebeEventCb
#Variables
#JS Bundle API Functions
#Other Functions
- ensureCoreOptions
- ensureString
- errorToMessage
- getRenderMimeRegistry
- getRenderers
- makeBinderOptions
- makeConfiguration
- makeKernelOptions
- makeMathjaxOptions
- makeSavedSessionOptions
- makeServerSettings
- setupNotebook
- setupThebeCore
- shortId
#Type Aliases
#EventObject
Ƭ EventObject: ThebeServer | ThebeSession | ThebeNotebook | ThebeCell
#Defined in
packages/core/src/events.ts:73
#JsonObject
Ƭ JsonObject: Record<string, any>
#Defined in
#KernelISpecModel
Ƭ KernelISpecModel: KernelSpecAPI.ISpecModel
#Defined in
#KernelISpecModels
Ƭ KernelISpecModels: KernelSpecAPI.ISpecModels
#Defined in
#MathjaxOptions
Ƭ MathjaxOptions: Pick<CoreOptions, "mathjaxConfig" | "mathjaxUrl">
#Defined in
#SessionIModel
Ƭ SessionIModel: Session.IModel
#Defined in
#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
| Name | Type |
|---|---|
event | string |
data | ThebeEventData |
#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
| Name | Type |
|---|---|
config | Config |
#Returns
ThebeServer
#Defined in
packages/core/src/thebe/api.ts:16
#Other Functions
#ensureCoreOptions
▸ ensureCoreOptions(options, events?): Required<CoreOptions>
#Parameters
| Name | Type |
|---|---|
options | CoreOptions & { [k: string]: any; } |
events? | ThebeEvents |
#Returns
Required<CoreOptions>
#Defined in
packages/core/src/options.ts:65
#ensureString
▸ ensureString(maybeString): string
#Parameters
| Name | Type |
|---|---|
maybeString | string | string[] |
#Returns
string
#Defined in
#errorToMessage
▸ errorToMessage(json): string
#Parameters
| Name | Type |
|---|---|
json | IError |
#Returns
string
#Defined in
packages/core/src/events.ts:58
#getRenderMimeRegistry
▸ getRenderMimeRegistry(mathjax?): RenderMimeRegistry
#Parameters
| Name | Type |
|---|---|
mathjax? | MathjaxOptions |
#Returns
RenderMimeRegistry
#Defined in
packages/core/src/rendermime.ts:58
#getRenderers
▸ getRenderers(mathjax): Object
#Parameters
| Name | Type |
|---|---|
mathjax | MathjaxOptions |
#Returns
Object
| Name | Type |
|---|---|
initialFactories | IRendererFactory[] |
latexTypesetter | undefined | MathJaxTypesetter |
#Defined in
packages/core/src/rendermime.ts:29
#makeBinderOptions
▸ makeBinderOptions(opts): Object
#Parameters
| Name | Type |
|---|---|
opts | BinderOptions |
#Returns
Object
| Name | Type |
|---|---|
binderUrl | string |
ref | string |
repo | string |
repoProvider | RepoProvider |
#Defined in
packages/core/src/options.ts:13
#makeConfiguration
▸ makeConfiguration(options, events?): Config
#Parameters
| Name | Type |
|---|---|
options | CoreOptions & { [k: string]: any; } |
events? | ThebeEvents |
#Returns
#Defined in
packages/core/src/options.ts:58
#makeKernelOptions
▸ makeKernelOptions(opts): Object
#Parameters
| Name | Type |
|---|---|
opts | KernelOptions |
#Returns
Object
| Name | Type |
|---|---|
kernelName | string |
name | string |
path | string |
#Defined in
packages/core/src/options.ts:32
#makeMathjaxOptions
▸ makeMathjaxOptions(opts?): Object
#Parameters
| Name | Type |
|---|---|
opts? | MathjaxOptions |
#Returns
Object
| Name | Type |
|---|---|
mathjaxConfig | string |
mathjaxUrl | string |
#Defined in
packages/core/src/options.ts:50
#makeSavedSessionOptions
▸ makeSavedSessionOptions(opts): Object
#Parameters
| Name | Type |
|---|---|
opts | SavedSessionOptions |
#Returns
Object
| Name | Type |
|---|---|
enabled | boolean |
maxAge | number |
storagePrefix | string |
#Defined in
packages/core/src/options.ts:23
#makeServerSettings
▸ makeServerSettings(settings): Object
#Parameters
| Name | Type |
|---|---|
settings | ServerSettings |
#Returns
Object
| Name | Type |
|---|---|
appendToken | boolean |
baseUrl | string |
token | string |
wsUrl? | string |
#Defined in
packages/core/src/options.ts:41
#setupNotebook
▸ setupNotebook(blocks, options, events): ThebeNotebook
#Parameters
| Name | Type |
|---|---|
blocks | CodeBlock[] |
options | CoreOptions |
events | ThebeEvents |
#Returns
#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