Update pages.d.ts (#222)

cloudflare · Apr 22, 2022 · b96c23c · b96c23c
1 parent fab61ed
commit b96c23c
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/.changeset/wicked-knives-own.md b/.changeset/wicked-knives-own.md
@@ -0,0 +1,5 @@
+---
+"@cloudflare/workers-types": minor
+---
+
+feature: Adds the `PagesPluginFunction` type and internal `functionPath` to Functions' context.
diff --git a/manual-ts/pages.d.ts b/manual-ts/pages.d.ts
@@ -2,6 +2,7 @@ type Params<P extends string = any> = Record<P, string | string[]>;
 
 type EventContext<Env, P extends string, Data> = {
   request: Request;
+  functionPath: string;
   waitUntil: (promise: Promise<any>) => void;
   next: (input?: Request | string, init?: RequestInit) => Promise<Response>;
   env: Env & { ASSETS: { fetch: typeof fetch } };
@@ -14,3 +15,23 @@ declare type PagesFunction<
   Params extends string = any,
   Data extends Record<string, unknown> = Record<string, unknown>
 > = (context: EventContext<Env, Params, Data>) => Response | Promise<Response>;
+
+type EventPluginContext<Env, P extends string, Data, PluginArgs> = {
+  request: Request;
+  functionPath: string;
+  waitUntil: (promise: Promise<any>) => void;
+  next: (input?: Request | string, init?: RequestInit) => Promise<Response>;
+  env: Env & { ASSETS: { fetch: typeof fetch } };
+  params: Params<P>;
+  data: Data;
+  pluginArgs: PluginArgs;
+};
+
+declare type PagesPluginFunction<
+  Env = unknown,
+  Params extends string = any,
+  Data extends Record<string, unknown> = Record<string, unknown>,
+  PluginArgs = unknown
+> = (
+  context: EventPluginContext<Env, Params, Data, PluginArgs>
+) => Response | Promise<Response>;