Skip to content

@pumpkin-plugins/pumpkin-pie-api API / expansion / ExpansionRouter

Class: ExpansionRouter ​

Defined in: tools/apis/pumpkin-pie-api/src/expansion.ts:34

Dispatches authenticated provider callbacks to locally owned handlers.

Constructors ​

Constructor ​

new ExpansionRouter(guard, provider?): ExpansionRouter

Defined in: tools/apis/pumpkin-pie-api/src/expansion.ts:37

The guard must also be passed to this plugin's clients.

Parameters ​

guard ​

CallbackGuard

provider? ​

string = PIE_PROVIDER

Returns ​

ExpansionRouter

Methods ​

handle() ​

handle(sender, bytes): Uint8Array

Defined in: tools/apis/pumpkin-pie-api/src/expansion.ts:61

Process actual host sender and bytes; errors never expose handler secrets.

Parameters ​

sender ​

string

bytes ​

Uint8Array

Returns ​

Uint8Array


register() ​

register(namespace, handlers): readonly string[]

Defined in: tools/apis/pumpkin-pie-api/src/expansion.ts:42

Claim local callback ownership and snapshot normalized handlers.

Parameters ​

namespace ​

string

handlers ​

Readonly<Record<string, ExpansionHandler>>

Returns ​

readonly string[]


remove() ​

remove(namespace): void

Defined in: tools/apis/pumpkin-pie-api/src/expansion.ts:56

Drop local ownership; provider unregistration is separately plugin-wide.

Parameters ​

namespace ​

string

Returns ​

void

pumpkin-plugins documentation