Prerender plugin

• Recache spends renders. recache caches a URL for the first time or refreshes one already cached, and each URL counts as one render against the plan (paid plans bill renders past the included amount). Refreshing only the pages that changed is how a longer global cache expiration stays affordable. One call takes either a single url or up to 1000 urls.
• Mobile is a separate entry. Add adaptiveType: 'mobile' to act on the mobile rendering rather than the desktop one, and the same filter on search to read one of the two.
• Search pages by 200. search matches a substring with query or a whole URL with exactMatch (with neither, it lists the whole cache), at 200 results per page, and takes start for the next page. It allows 50 requests a minute and answers 429 past that.
• A sitemap adds only new URLs. sitemap renders and caches what is not cached yet, one render per new URL, and leaves existing entries alone, so use recache to refresh them.
• Clearing is a job. cacheClear takes a SQL-like pattern where % matches any run, schedules a job, and only one job runs at a time. Check it with cacheClearStatus, whose inProgress is true while a job runs.
• Recache speed affects your origin. changeSpeed sets how many URLs the queue renders per hour, from 3600 up to 36000, or 0 to restore the automatic delay. A faster rate can overload the origin, so confirm the stack can take it first.

• 6 typed API operations

Setup

npm install corsair @corsair-dev/prerender better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/prerender better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/prerender better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/prerender better-sqlite3
bun add --dev @types/better-sqlite3

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { prerender } from '@corsair-dev/prerender';

export const corsair = createCorsair({
	plugins: [
		prerender(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

prerender()

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'prerender',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.prerender.api.cache.search({ query: 'example.com/path', start: 0 });

const tenant = corsair.withTenant('acme');
await tenant.prerender.api.cache.recache({ url: 'https://example.com/pricing' });

What’s next