mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2026-09-03 05:10:16 +03:00
# Description of Changes <!-- Please provide a summary of the changes, including: - What was changed - Why the change was made - Any challenges encountered Closes #(issue_number) --> --- ## Checklist ### General - [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [ ] I have performed a self-review of my own code - [ ] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### Translations (if applicable) - [ ] I ran [`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have run `task check` to verify linters, typechecks, and tests pass - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#7-testing) for more details.
35 lines
831 B
TypeScript
35 lines
831 B
TypeScript
// Type declarations for og-prerender.mjs (plain ESM build helper).
|
|
|
|
export interface OgEntry {
|
|
image: string;
|
|
title: string;
|
|
description: string;
|
|
/** Punchier social-card title; falls back to `title` for the <title> tag. */
|
|
ogTitle?: string;
|
|
}
|
|
|
|
export interface OgInjectOptions {
|
|
ogBase?: string;
|
|
pageUrlPath?: string | null;
|
|
}
|
|
|
|
export interface OgManifest {
|
|
default: OgEntry;
|
|
byTool: Record<string, OgEntry>;
|
|
byPath: Record<string, string>;
|
|
}
|
|
|
|
export function escapeHtml(value: string): string;
|
|
export function buildOgTags(entry: OgEntry, opts?: OgInjectOptions): string;
|
|
export function injectOg(
|
|
html: string,
|
|
entry: OgEntry,
|
|
opts?: OgInjectOptions,
|
|
): string;
|
|
export function prerenderOg(args: {
|
|
distDir: string;
|
|
manifest: OgManifest;
|
|
ogBase?: string;
|
|
baseHref?: string;
|
|
}): Promise<number>;
|