Interface: BackendPluginApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:519

The API object handed to a backend plugin worker's activate() (apps/server/worker/plugin-worker.mjs). Network, storage and events are capability/permission gated by the host.

Properties

events

readonly events: object

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:528

clear()

clear(): void

Returns

void

emit()

emit(event, payload?): Promise<unknown>

Parameters

event

string

payload?

unknown

Returns

Promise<unknown>

off()

off(event, handler): void

Parameters

event

string

handler

(payload) => unknown

Returns

void

on()

on(event, handler): Unregister

Parameters

event

string

handler

(payload) => unknown

Returns

Unregister

---

files

readonly files: object

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:544

delete()

delete(path): Promise<unknown>

Parameters

path

string

Returns

Promise<unknown>

list()

list(path): Promise<string[]>

Parameters

path

string

Returns

Promise<string[]>

read()

read(path): Promise<string>

Parameters

path

string

Returns

Promise<string>

write()

write(path, content): Promise<unknown>

Parameters

path

string

content

string

Returns

Promise<unknown>

---

logger

readonly logger: BackendPluginLogger

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:534

---

pluginId

readonly pluginId: string

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:520

---

routes

readonly routes: BackendRouter

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:521

---

storage

readonly storage: object

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:522

delete()

delete(key): Promise<unknown>

Parameters

key

string

Returns

Promise<unknown>

get()

get(key): Promise<unknown>

Parameters

key

string

Returns

Promise<unknown>

keys()

keys(): Promise<string[]>

Returns

Promise<string[]>

set()

set(key, value): Promise<unknown>

Parameters

key

string

value

unknown

Returns

Promise<unknown>

Methods

fetch()

fetch(url, init?): Promise<{ ok: boolean; status: number; json: Promise<unknown>; text: Promise<string>; }>

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:535

Parameters

url

string

init?

body?

string

headers?

Record<string, string>

method?

string

Returns

Promise<{ ok: boolean; status: number; json: Promise<unknown>; text: Promise<string>; }>