Skip to main content
Deno 2 is finally here πŸŽ‰οΈ
Learn more
Module

x/gustwind/types.ts>PluginApi

πŸ³πŸ’¨ – Deno powered site creator
Go to Latest
type alias PluginApi
import { type PluginApi } from "https://deno.land/x/gustwind@v0.56.1/types.ts";
definition: { initPluginContext?(): C | Promise<C>; sendMessages?(unnamed 0: { send: Send; pluginContext: C; }): Promise<Tasks | void> | Tasks | void; prepareBuild?(unnamed 0: { send: Send; pluginContext: C; }): Promise<Tasks | void> | Tasks | void; finishBuild?(unnamed 0: { send: Send; pluginContext: C; }): Promise<Tasks | void> | Tasks | void; cleanUp?(unnamed 0: { routes: Routes; pluginContext: C; }): void; prepareContext?(unnamed 0: { send: Send; route: Route; url: string; pluginContext: C; }): Promise<{ context: Record<string, unknown>; } | void> | { context: Record<string, unknown>; } | void; beforeEachRender?(unnamed 0: { context: Context; send: Send; route: Route; url: string; pluginContext: C; }): Promise<Tasks | void> | Tasks | void; render?(unnamed 0: { routes: Routes; route: Route; context: Context; send: Send; url: string; pluginContext: C; }): Promise<string> | string; afterEachRender?(unnamed 0: { markup: string; context: Context; route: Route; send: Send; url: string; pluginContext: C; }): Promise<{ markup: string; }> | { markup: string; }; onMessage?(unnamed 0: { message: SendMessageEvent; pluginContext: C; }): void | { send?: SendMessageEvent[]; pluginContext?: Partial<C>; result?: unknown; } | Promise<void | { send?: SendMessageEvent[]; pluginContext?: Partial<C>; result?: unknown; }>; getAllRoutes?(unnamed 0: { pluginContext: C; }): Promise<{ routes: Record<string, Route>; tasks: Tasks; }> | { routes: Record<string, Route>; tasks: Tasks; }; matchRoute?(
allRoutes: Routes,
url: string,
pluginContext: C,
): Promise<{ route?: Route; tasks: Tasks; allRoutes: Routes; }> | { route?: Route; tasks: Tasks; allRoutes: Routes; }; onTasksRegistered?(unnamed 0: { tasks: Tasks; send: Send; }): void; }