Class KernelExperimental

constructor

• new Kernel(_options?: KernelOptions): Kernel
• Experimental

  Parameters

  • _options: KernelOptions = DefaultKernelOptions

  Returns Kernel

Readonly Experimentalauth

Optional Experimentalbios

Readonly Experimentalchannel

Readonly Experimentalcomponents

Optional Experimentalcontainer

Readonly Experimentaldevices

Readonly Experimentaldom

Readonly Experimentalevents

Readonly Experimentalfilesystem

Readonly Experimentali18n

Readonly Experimentalid

Readonly Experimentalintervals

Readonly Experimentalkeyboard

Readonly Experimentallog

Readonly Experimentalmemory

Readonly Experimentalmodules

Readonly Experimentalname

Readonly Experimentaloptions

Readonly Experimentalpackages

Readonly Experimentalprocesses

Readonly Experimentalprotocol

Readonly Experimentalscreensavers

Readonly Experimentalservice

Readonly Experimentalshell

Readonly Experimentalstorage

Readonly Experimentalterminal

Readonly Experimentaltoast

Readonly Experimentalusers

Readonly Experimentalversion

Readonly Experimentalwasm

Readonly Experimentalwindows

Readonly Experimentalworkers

addEventListener

• get addEventListener(): <T>(event: string, callback: EventCallback<T>) => void
• Experimental

  Add an event listener; alias for events.on

  Returns <T>(event: string, callback: EventCallback<T>) => void

  • • <T>(event: string, callback: EventCallback<T>): void

    • Add an event listener

      Type Parameters

      • T

      Parameters

      • event: string

        Event name
      • callback: EventCallback<T>

        Event handler

      Returns void

removeEventListener

• get removeEventListener(): <T>(
      event: string,
      callback: EventCallback<T>,
  ) => void
• Experimental

  Remove an event listener; alias for events.off

  Returns <T>(event: string, callback: EventCallback<T>) => void

  • • <T>(event: string, callback: EventCallback<T>): void

    • Remove an event listener

      Type Parameters

      • T

      Parameters

      • event: string

        Event name
      • callback: EventCallback<T>

        Event handler

      Returns void

state

• get state(): KernelState
• Experimental

  Current state of the kernel

  Returns KernelState

boot

• boot(options?: BootOptions): Promise<void>
• Experimental

  Boots the kernel and initializes all core services.

  Parameters

  • options: BootOptions = DefaultBootOptions

    Boot configuration options

  Returns Promise<void>

  Throws

  If boot process fails

configure

• configure(options: KernelOptions): Promise<void>
• Experimental

  Configures kernel subsystems with the provided options

  Parameters

  • options: KernelOptions

    Configuration options for kernel subsystems

  Returns Promise<void>

execute

• execute(options: KernelExecuteOptions): Promise<number>
• Experimental

  Executes a command in the kernel environment

  Parameters

  • options: KernelExecuteOptions

    Execution options containing command, args, and shell

  Returns Promise<number>

  Exit code of the command

executeApp

• executeApp(options: KernelExecuteOptions): Promise<number>
• Experimental

  Executes an app

  Parameters

  • options: KernelExecuteOptions

    Execution options containing app path and shell

  Returns Promise<number>

  Exit code of the app

executeCommand

• executeCommand(options: KernelExecuteOptions): Promise<number>
• Experimental

  Executes a terminal command

  Parameters

  • options: KernelExecuteOptions

    Execution options containing command name, args, shell, and terminal

  Returns Promise<number>

  Exit code of the command

executeDevice

• executeDevice(
      device: KernelDevice,
      args?: string[],
      shell?: Shell,
  ): Promise<number>
• Experimental

  Executes a device command

  Parameters

  • device: KernelDevice

    Device to execute command on
  • args: string[] = []

    Command arguments
  • shell: Shell = ...

    Shell instance

  Returns Promise<number>

  Exit code of the device command

executeNode

• executeNode(options: KernelExecuteOptions): Promise<number>
• Experimental

  Executes a node script (or tries to)

  Parameters

  • options: KernelExecuteOptions

    Execution options containing script path and shell

  Returns Promise<number>

  Exit code of the script

  Remarks

  Don't expect it to work; this will help develop further emulation layers We still need to resolve the IndexedDB/sync issues before sync fs calls will work

executeScript

• executeScript(options: KernelExecuteOptions): Promise<number>
• Experimental

  Executes a script file

  Parameters

  • options: KernelExecuteOptions

    Execution options containing script path and shell

  Returns Promise<number>

  Exit code of the script

getPackageMainExport

• getPackageMainExport(pkgData: JSONSchemaForNPMPackageJsonFiles): null | string
• Experimental

  Gets the main entry file path from a package.json

  Parameters

  • pkgData: JSONSchemaForNPMPackageJsonFiles

    The parsed package.json data

  Returns null | string

  The main entry file path or null if not found

notify

• notify(
      title: string,
      options?: NotificationOptions,
  ): Promise<void | Notification>
• Experimental

  Shows a system notification if permissions are granted

  Parameters

  • title: string

    Notification title
  • options: NotificationOptions = {}

    Notification options

  Returns Promise<void | Notification>

  The created notification or void if permissions denied

off

• off(event: KernelEvents, listener: EventCallback): void
• Experimental

  Removes an event listener from the kernel.

  Parameters

  • event: KernelEvents

    The event to remove the listener from.
  • listener: EventCallback

    The listener to remove.

  Returns void

on

• on(event: KernelEvents, listener: EventCallback): void
• Experimental

  Adds an event listener to the kernel.

  Parameters

  • event: KernelEvents

    The event to listen for.
  • listener: EventCallback

    The listener to add.

  Returns void

readFileHeader

• readFileHeader(filePath: string): Promise<null | FileHeader>
• Experimental

  Reads and parses a file header to determine its type

  Parameters

  • filePath: string

    Path to the file

  Returns Promise<null | FileHeader>

  Parsed header information or null if invalid

reboot

• reboot(): Promise<void>
• Experimental

  Reboots the kernel by performing a shutdown and page reload

  Returns Promise<void>

registerCommands

• registerCommands(): Promise<void>
• Experimental

  Registers the terminal commands.

  Returns Promise<void>

  A promise that resolves when the terminal commands are registered.

registerDevices

• registerDevices(): Promise<void>
• Experimental

  Registers the devices.

  Returns Promise<void>

  A promise that resolves when the devices are registered.

registerEvents

• registerEvents(): Promise<void>
• Experimental

  Registers the kernel events.

  Returns Promise<void>

  A promise that resolves when the events are registered.

registerPackages

• registerPackages(): Promise<void>
• Experimental

  Registers the packages from /etc/packages that should be auto-loaded on boot.

  Returns Promise<void>

  A promise that resolves when the packages are registered.

registerProc

• registerProc(): Promise<void>
• Experimental

  Registers the initial /proc entries.

  Returns Promise<void>

  A promise that resolves when the proc entries are registered.

replaceImports

• replaceImports(contents: string, packagePath: string): Promise<string>
• Experimental

  Replaces imports in a script with SWAPI URLs

  Parameters

  • contents: string

    The script contents
  • packagePath: string

  Returns Promise<string>

  The modified script contents

  Remarks

  I would love to just use import maps, but we need dynamic import maps This is probably not our long-term solution

shutdown

• shutdown(): Promise<void>
• Experimental

  Shuts down the kernel.

  Returns Promise<void>

  A promise that resolves when the kernel is shut down.