website-screenshot-api

an api to take screenshots of sites or HTML

setup

docker-compose up

name	type	description	default
`input`	`string`	either a URL to navigate to or HTML to be rendered	(required)
`screenshotMode`	`'normal' \| 'full' \| 'element'`	- `normal`: takes a screenshot of the contents visible in the viewport (default if `input` is a url) - `full`: includes the entire page in the screenshot - `element`: mainly for when the input is html, only includes the html content and no empty space. probably won't work properly for most websites (default if `input` is html)	(depends, see description)
`blockAds`	`boolean`	whether to block ads using `@cliqz/adblocker-playwright`	`true`
`timeout`	`number`	the number of milliseconds to wait for the site to load before timing out	`60000`

Name		Name	Last commit message	Last commit date
Latest commit History 76 Commits
.github/workflows		.github/workflows
.idea		.idea
.vscode		.vscode
examples		examples
src		src
tests		tests
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc.json		.prettierrc.json
Dockerfile		Dockerfile
docker-compose.yml		docker-compose.yml
jest.config.ts		jest.config.ts
nodemon.json		nodemon.json
package-lock.json		package-lock.json
package.json		package.json
readme.md		readme.md
tsconfig.json		tsconfig.json
website-screenshot.iml		website-screenshot.iml