Skip to content

feat: types for prerender options and result; better result checks #29

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
rschristian merged 4 commits into from
Feb 6, 2026
Merged

feat: types for prerender options and result; better result checks #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
40d3251
feat: types for prerender options and result; better result checks
crutch12 Dec 9, 2025
47c6205
chore: Revert unnecessary changes
rschristian Feb 6, 2026
4d9886f
fix: Correct & re-export types
rschristian Feb 6, 2026
2b4bc84
chore: Ensure TS LSP raises errors on `.d.ts` files
rschristian Feb 6, 2026
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
3 changes: 2 additions & 1 deletion jsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"allowJs": true,
"checkJs": true,
"resolveJsonModule": true,
"noEmit": true
"noEmit": true,
"skipLibCheck": false
}
}
2 changes: 2 additions & 0 deletions src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@ export interface PreviewMiddlewareOptions {
export type Options = PrerenderOptions & PreviewMiddlewareOptions;

export function vitePrerenderPlugin(options?: Options): Plugin[];

export type { PrerenderArguments, PrerenderResult } from './plugins/types.d.ts';
7 changes: 4 additions & 3 deletions src/plugins/prerender-plugin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ export function prerenderPlugin({ prerenderScript, renderTarget, additionalPrere
return message;
};

/** @type {import('./types.d.ts').Head} */
/** @type {Partial<import('./types.d.ts').Head>} */
let head = { lang: '', title: '', elements: new Set() };

let prerender;
Expand Down Expand Up @@ -420,6 +420,7 @@ export function prerenderPlugin({ prerenderScript, renderTarget, additionalPrere
} catch {}
}

/** @type {import('./types.d.ts').PrerenderResult} */
let result;
try {
result = await prerender({ ssr: true, url: route.url, route });
Expand Down Expand Up @@ -494,9 +495,9 @@ export function prerenderPlugin({ prerenderScript, renderTarget, additionalPrere
const target = htmlDoc.querySelector(renderTarget);
if (!target)
this.error(
result.renderTarget == 'body'
renderTarget == 'body'
? '`renderTarget` was not specified in plugin options and <body> does not exist in input HTML template'
: `Unable to detect prerender renderTarget "${result.selector}" in input HTML template`,
: `Unable to detect prerender renderTarget "${renderTarget}" in input HTML template`,
Comment on lines -497 to +500
Copy link
Member

@rschristian rschristian Dec 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oof, good spot on both (or good spot from the types). Changed this API ages ago and I guess it slipped through.

);
target.insertAdjacentHTML('afterbegin', body);

Expand Down
13 changes: 13 additions & 0 deletions src/plugins/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,16 @@ export interface PrerenderedRoute {
url: string;
_discoveredBy?: PrerenderedRoute;
}

export interface PrerenderArguments {
ssr: true;
url: string;
route: PrerenderedRoute;
}

export type PrerenderResult = {
html: string;
links?: Set<string>;
data?: any;
head?: Partial<Head>;
} | string