Skip to content

apollo-code


apollo-code / plugin-runtime/src / BridgeHost

Interface: BridgeHost

Properties

fs

fs: object

exists()

exists(path): Promise<boolean>

Parameters
path

string

Returns

Promise<boolean>

glob()

glob(pattern, cwd): Promise<string[]>

Parameters
pattern

string

cwd

string

Returns

Promise<string[]>

readFile()

readFile(path, encoding?): Promise<string | Uint8Array<ArrayBufferLike>>

Parameters
path

string

encoding?

string

Returns

Promise<string | Uint8Array<ArrayBufferLike>>

stat()

stat(path): Promise<unknown>

Parameters
path

string

Returns

Promise<unknown>

writeFile()

writeFile(path, data): Promise<void>

Parameters
path

string

data

string | Uint8Array<ArrayBufferLike>

Returns

Promise<void>


session

readonly session: BridgeSessionSnapshot

Methods

config()

config(plugin, key): unknown

Parameters

plugin

string

key

string

Returns

unknown


exec()

exec(command, options, signal): Promise<unknown>

Parameters

command

string

options

unknown

signal

AbortSignal

Returns

Promise<unknown>


fetch()

fetch(url, init, signal): Promise<unknown>

Parameters

url

string

init

unknown

signal

AbortSignal

Returns

Promise<unknown>


log()

log(level, message, meta?): void

Parameters

level

string

message

string

meta?

unknown

Returns

void


memory()?

optional memory(plugin, operation, params): Promise<unknown>

Parameters

plugin

string

operation

"search" | "delete" | "get" | "export" | "list" | "create" | "update"

params

unknown

Returns

Promise<unknown>


register()

register(kind, value, plugin): Disposable

Parameters

kind

"tool" | "ui" | "command" | "prompt"

value

unknown

plugin

string

Returns

Disposable


storage()

storage(plugin, operation, key, value?): Promise<unknown>

Parameters

plugin

string

operation

"delete" | "get" | "set"

key

string

value?

unknown

Returns

Promise<unknown>


ui()

ui(method, params): unknown

Parameters

method

"confirm" | "prompt" | "pick" | "notify"

params

unknown

Returns

unknown