Class BashKitAddon

Browser-terminal addon backed by a single-process BashKit interpreter.

Implements

TerminalAddon

Index

Constructors

Properties

Methods

activate dispose

Constructors

constructor

new BashKitAddon(options?: BashKitAddonOptions): BashKitAddon
Creates an addon without loading BashKit until activation.
Parameters
- options: BashKitAddonOptions = {}
Returns BashKitAddon
- Defined in bashkit/src/addon.ts:19

Properties

`Readonly`ready

ready: Promise<BashKitAddonReady>

Resolves after BashKit starts and its byte streams are connected.

Methods

activate

activate(terminal: BrowserTerminal): void
Loads BashKit and connects it to the activating terminal.
Parameters
- terminal: BrowserTerminal
Returns void
Implementation of TerminalAddon.activate
- Defined in bashkit/src/addon.ts:28

dispose

dispose(): void
Releases the connection and interpreter resources.

Returns void
Implementation of TerminalAddon.dispose
- Defined in bashkit/src/addon.ts:36