Skip to content

feat: add headers to plugin context type #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dylankilkenny merged 1 commit into from
Dec 2, 2025
+14 −1
Merged

feat: add headers to plugin context type #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions custom-models/plugin-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,12 +184,19 @@ export interface PluginKVStore {
): Promise<T | null>;
}

/**
* HTTP headers from the incoming request.
* Each header name maps to an array of values (since HTTP headers can have multiple values).
*/
export type PluginHeaders = Record<string, string[]>;

/**
* Plugin context with KV always available for modern plugins.
*/
export interface PluginContext {
api: PluginAPI;
kv: PluginKVStore;
headers: PluginHeaders;
params: any;
}

Expand Down
8 changes: 7 additions & 1 deletion src/models/plugin-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,13 +184,19 @@ export interface PluginKVStore {
): Promise<T | null>;
}

/**
* HTTP headers from the incoming request.
* Each header name maps to an array of values (since HTTP headers can have multiple values).
*/
export type PluginHeaders = Record<string, string[]>;

/**
* Plugin context with KV always available for modern plugins.
*/
export interface PluginContext {
api: PluginAPI;
kv: PluginKVStore;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
headers: PluginHeaders;
params: any;
}

Expand Down