@nanggo/social-preview
Version:
Generate beautiful social media preview images from any URL
22 lines (21 loc) • 880 B
TypeScript
/**
* Social Preview Generator
* Generate beautiful social media preview images from any URL
*/
import { PreviewOptions, ExtractedMetadata, GeneratedPreview, TemplateConfig } from './types';
export * from './exports';
/**
* 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 image with specific template
*/
export declare function generateImageWithTemplate(metadata: ExtractedMetadata, template: TemplateConfig, options: PreviewOptions): Promise<Buffer>;
/**
* Generate preview with full result details
*/
export declare function generatePreviewWithDetails(url: string, options?: PreviewOptions): Promise<GeneratedPreview>;