Class KernelBase

constructor

• new KernelBase(options: any): KernelBase

  Parameters

  • options: any

  Returns KernelBase

_execution_count

execution_count

• get execution_count(): number

  Execution count getter.

  Returns number

ready

• get ready(): boolean

  Is the kernel ready?

  Returns boolean

addEventListener

• addEventListener(eventName: string, callback: (_: any) => void): void

  Wrapper around document.addEventListener. It manages the 'basthon.' prefix to each event name and manage the event lookup to retreive relevent data.

  Parameters

  • eventName: string
  • callback: (_: any) => void

  Returns void

banner

• banner(): string

  Returns string

basthonRoot

• basthonRoot(absolute?: boolean): string

  Root for kernel files. This is always the language directory inside the version number directory inside the kernel directory.

  Parameters

  • Optionalabsolute: boolean

  Returns string

clone

• clone(obj: any): any

  Simple clone via JSON copy.

  Parameters

  • obj: any

  Returns any

complete

• complete(code: string): [] | [string[], number]

  Parameters

  • code: string

  Returns [] | [string[], number]

dispatchEvent

• dispatchEvent(eventName: string, data: any): void

  Wrapper around document.dispatchEvent. It adds the 'basthon.' prefix to each event name and manage the event lookup to retreive relevent data.

  Parameters

  • eventName: string
  • data: any

  Returns void

download

• download(data: string | Uint8Array<ArrayBufferLike>, filename: string): void

  Downloading data (bytes array or data URL) as filename (opening browser dialog).

  Parameters

  • data: string | Uint8Array<ArrayBufferLike>
  • filename: string

  Returns void

evalAsync

• evalAsync(
      code: string,
      outCallback: (_: string) => void,
      errCallback: (_: string) => void,
      data?: any,
  ): Promise<any>

  Async code evaluation that resolves with the result.

  Parameters

  • code: string
  • outCallback: (_: string) => void
  • errCallback: (_: string) => void
  • Optionaldata: any

  Returns Promise<any>

evalFromEvent

• evalFromEvent(data: any): Promise<void>

  Internal. Code evaluation after an eval.request event.

  Parameters

  • data: any

  Returns Promise<void>

getFile

• getFile(path: string): void

  Parameters

  • path: string

  Returns void

getUserModuleFile

• getUserModuleFile(filename: string): void

  Parameters

  • filename: string

  Returns void

init

• init(): Promise<void>

  Initialize the kernel.

  Returns Promise<void>

inputAsync

• inputAsync(
      prompt: string | null | undefined,
      password?: boolean,
      data?: any,
  ): Promise<unknown>

  Send eval.input event then wait for the user response and return it.

  Parameters

  • prompt: string | null | undefined
  • Optionalpassword: boolean
  • Optionaldata: any

  Returns Promise<unknown>

language

• language(): string

  Language implemented in the kernel (string). Generally lower case.

  Returns string

languageName

• languageName(): string

  Language name implemented in the kernel (string). As it should be displayed in text.

  Returns string

launch

• launch(): Promise<void>

  Launch the kernel.

  Returns Promise<void>

loaded

• loaded(): Promise<void>

  Promise that resolve when the kernel is loaded.

  Returns Promise<void>

moduleExts

• moduleExts(): string[]

  Script (module) file extensions

  Returns string[]

more

• more(source: string): boolean

  Parameters

  • source: string

  Returns boolean

ps1

• ps1(): string

  Returns string

ps2

• ps2(): string

  Returns string

putFile

• putFile(filename: string, content: ArrayBuffer): Promise<void>

  Parameters

  • filename: string
  • content: ArrayBuffer

  Returns Promise<void>

putModule

• putModule(filename: string, content: ArrayBuffer): Promise<void>

  Parameters

  • filename: string
  • content: ArrayBuffer

  Returns Promise<void>

putRessource

• putRessource(filename: string, content: ArrayBuffer): Promise<void>

  Put a ressource (file or module). Detection is based on extension.

  Parameters

  • filename: string
  • content: ArrayBuffer

  Returns Promise<void>

restart

• restart(): void

  Returns void

userModules

• userModules(): string[]

  Returns string[]

version

• version(): string

  Kernel version number (string).

  Returns string

StaticloadScript

• loadScript(url: string): Promise<any>

  Dynamically load a script asynchronously.

  Parameters

  • url: string

  Returns Promise<any>