UNPKG

@nanggo/social-preview

Version:

Generate beautiful social media preview images from any URL

18 lines (17 loc) • 804 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
/** * Social Preview Generator * Generate beautiful social media preview images from any URL */ import { PreviewOptions, ExtractedMetadata, GeneratedPreview, TemplateConfig, ErrorType, PreviewGeneratorError } from './types'; export { PreviewOptions, ExtractedMetadata, GeneratedPreview, TemplateConfig, ErrorType, PreviewGeneratorError }; /** * Generate a social preview image from a URL * @param url - The URL to generate preview for * @param options - Configuration options * @returns Buffer containing the generated image */ export declare function generatePreview(url: string, options?: PreviewOptions): Promise<Buffer>; /** * Generate preview with full result details */ export declare function generatePreviewWithDetails(url: string, options?: PreviewOptions): Promise<GeneratedPreview>;