-
🥞 Completely composable
You can include multiple Plugins, Plugins can rely on other Plugins, and they all share the same loading interface.
-
✍️ Author a Plugin as a folder of Functions
The straight-forward syntax and intuitive file-based routing we've developed for Functions can be used to write Plugins.
-
📥 Simple loading mechanism for including Plugins in projects
Mount the Plugin wherever you want and optionally pass it data.
-
⚡️ Plugins can bring static assets
We hide static assets behind an inaccessible URL (
/cdn-cgi/) so they'll only be available in user-land where the Plugin exposes them. And everything gracefully-ish falls back to the origin if deploying a regular Worker instead of a Pages project.
Check out the example application which includes all the Plugins we have so far.
If you want to run it with wrangler2, run this:
git clone [email protected]:GregBrimble/pages-plugins.git;
cd pages-plugins;
npm install;
npm start;Check out these examples:
This is the bit of the path that we matched on when deciding which Function to execute. (e.g. _middleware.ts on root would be /, a date.ts would be /date, and an [path].ts would be /foo).
The Plugin needs to know where it's mounted in order to figure out its relative routing.
type EventContext<Env, P extends string, Data> = {
request: Request;
functionPath: string;
waitUntil: (promise: Promise<unknown>) => void;
next: (input?: Request | string, init?: RequestInit) => Promise<Response>;
env: Env & { ASSETS: { fetch: typeof fetch } };
params: Params<P>;
data: Data;
};- More Plugins
- Static assets
- A testing story