apollo-code

---

apollo-code / plugin-sdk/src / ApolloBridge

Interface: ApolloBridge

Properties

apiVersion

readonly apiVersion: "1.0"

---

commands

readonly commands: object

register()

register(spec): Disposable

Parameters

spec

CommandSpec

Returns

Disposable

---

config

readonly config: object

get()

get<T>(key): T

Type Parameters

T

T = unknown

Parameters

key

string

Returns

T

---

fs

readonly fs: object

exists()

exists(path): Promise<boolean>

Parameters

path

string

Returns

Promise<boolean>

glob()

glob(pattern): Promise<string[]>

Parameters

pattern

string

Returns

Promise<string[]>

readFile()

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

Parameters

path

string

encoding?

"utf-8" | "binary"

Returns

Promise<string | Uint8Array<ArrayBufferLike>>

stat()

stat(path): Promise<FileStat>

Parameters

path

string

Returns

Promise<FileStat>

writeFile()

writeFile(path, data): Promise<void>

Parameters

path

string

data

string | Uint8Array<ArrayBufferLike>

Returns

Promise<void>

---

hooks

readonly hooks: object

kv

readonly kv: object

kv.clear()

clear(): void

Returns

void

kv.delete()

delete(key): void

Parameters

key

string

Returns

void

kv.get()

get<T>(key): T | undefined

Type Parameters

T

T = unknown

Parameters

key

string

Returns

T | undefined

kv.set()

set(key, value): void

Parameters

key

string

value

unknown

Returns

void

off()

off(event, handler): void

Parameters

event

HookEvent

handler

HookHandler

Returns

void

on()

on(event, handler, options?): Disposable

Parameters

event

HookEvent

handler

HookHandler

options?

priority?

number

Returns

Disposable

---

http

readonly http: object

fetch()

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

Parameters

url

string

init?

Readonly<Record<string, unknown>>

Returns

Promise<unknown>

---

log

readonly log: object

debug()

debug(message, meta?): void

Parameters

message

string

meta?

object

Returns

void

error()

error(message, error?, meta?): void

Parameters

message

string

error?

unknown

meta?

object

Returns

void

info()

info(message, meta?): void

Parameters

message

string

meta?

object

Returns

void

warn()

warn(message, meta?): void

Parameters

message

string

meta?

object

Returns

void

---

memory

readonly memory: PluginMemoryBridge

---

plugin

readonly plugin: Readonly<{ dataDir: string; name: string; version: string; }>

---

prompt

readonly prompt: object

contribute()

contribute(fragment): Disposable

Parameters

fragment

PromptFragment

Returns

Disposable

revoke()

revoke(id): void

Parameters

id

string

Returns

void

---

session

readonly session: object

cwd

readonly cwd: string

id

readonly id: string

getMessages()

getMessages(range?): readonly Readonly<Message>[]

Parameters

range?

limit?

number

Returns

readonly Readonly<Message>[]

getUsage()

getUsage(): Readonly<Usage>

Returns

Readonly<Usage>

on()

on(event, handler): Disposable

Parameters

event

string

handler

(payload) => void

Returns

Disposable

---

storage

readonly storage: object

delete()

delete(key): Promise<void>

Parameters

key

string

Returns

Promise<void>

get()

get<T>(key): Promise<T | undefined>

Type Parameters

T

T = unknown

Parameters

key

string

Returns

Promise<T | undefined>

set()

set(key, value): Promise<void>

Parameters

key

string

value

unknown

Returns

Promise<void>

---

tools

readonly tools: object

register()

register(spec): Disposable

Parameters

spec

ToolSpec

Returns

Disposable

unregister()

unregister(name): void

Parameters

name

string

Returns

void

---

ui

readonly ui: object

confirm()

confirm(message): Promise<boolean>

Parameters

message

string

Returns

Promise<boolean>

notify()

notify(message, level?): void

Parameters

message

string

level?

"error" | "warn" | "info"

Returns

void

pick()

pick<T>(options, settings?): Promise<T | null>

Type Parameters

T

T

Parameters

options

readonly T[]

settings?

label

(value) => string

Returns

Promise<T | null>

prompt()

prompt(question, options?): Promise<string | null>

Parameters

question

string

options?

default?

string

secret?

boolean

Returns

Promise<string | null>

Methods

call()

call<T>(method, params?): Promise<T>

Low-level transport retained for sandbox hosts. Prefer the typed namespaces above.

Type Parameters

T

T = unknown

Parameters

method

string

params?

unknown

Returns

Promise<T>

---

exec()

exec(command, options?): Promise<{ code: number; stderr: string; stdout: string; }>

Parameters

command

string

options?

ExecOptions

Returns

Promise<{ code: number; stderr: string; stdout: string; }>