canvas-screenshot

canvas-screenshot

A one trick pony package to download an image from a canvas.

Installation

npm install canvas-screenshot

Usage

const canvasScreenshot = require("canvas-screenshot");
const createCanvasContext = require("canvas-context");

const { context } = createCanvasContext("2d", {
  width: 100,
  height: 100
});

const button = document.createElement("button");
button.addEventListener("click", () => {
  canvasScreenshot(context.canvas);
});

API

canvasScreenshot(canvas, options): DOMString | Promise<Blob>

Returns a Data URI or a Promise resolving with a Blob. Setting useBlob to true will consequently make the module async and return the latter.

Option	Type	Default	Description
canvas	HTMLCanvasElement		The canvas element
options.filename	string?	Screen Shot YYYY-MM-DD at HH.MM.SS.png	File name
options.quality	number?	1	Quality between 0 and 1
options.useBlob	boolean?	undefined	Use canvas.toBlob
options.download	boolean?	true	Automatically download the screenshot

Type is inferred from the filename extension (jpg/jpeg) for "image/jpeg" and default to "image/png".

License

MIT. See license file.

Changelog

4.0.0 (2021-04-16)

Code Refactoring

• use ES modules (70753d9)

BREAKING CHANGES

• switch to type module