Skip to content

Screenshot Service

网页截图服务,使用 Puppeteer 进行网页截图。

ScreenshotService

网页截图服务接口

screenshot

从 HTML 内容生成截图

typescript
screenshot(htmlContent, options?): Promise<string>
  • htmlContent: HTML 内容
  • options?: ScreenshotOptions 对象 返回: string - 截图文件路径

screenshotFromUrl

从 URL 生成截图

typescript
screenshotFromUrl(url, options?): Promise<string>
  • url: 网页 URL
  • options?: ScreenshotOptions 对象 返回: string - 截图文件路径

cleanupTemp

清理临时文件

typescript
cleanupTemp(olderThanMs?): Promise<number>
  • olderThanMs?: 删除指定毫秒前的文件,默认 3600000 返回: number - 删除的文件数量

ScreenshotOptions

截图选项

typescript
interface ScreenshotOptions {
  width?: number;
  height?: number;
  fullPage?: boolean;
  quality?: number;
  type?: "png" | "jpeg" | "webp";
  waitTime?: number;
}
  • width?: 视图宽度,默认 1920
  • height?: 视图高度,默认 1080
  • fullPage?: 是否截取完整页面,默认 false
  • quality?: 图片质量 1-100,仅 jpeg/webp
  • type?: 输出图片格式,默认 png
  • waitTime?: 超时时间(毫秒)
点击展开完整类型定义
typescript
interface ScreenshotService {
  screenshot(htmlContent: string, options?: ScreenshotOptions): Promise<string>;
  screenshotFromUrl(url: string, options?: ScreenshotOptions): Promise<string>;
  cleanupTemp(olderThanMs?: number): Promise<number>;
}

Released under the MIT License with love.