Skip to content

Latest commit

 

History

History
70 lines (52 loc) · 2.71 KB

README.md

File metadata and controls

70 lines (52 loc) · 2.71 KB

DeepScan grade NPM info GitHub stars GitHub issues

NPM Info

💻 Website Screenshot

Developed with ❤️ by Roxza

📦Installation

npm i webscreen --save
yarn add webscreen

📝 Usage

const captureWebsite = require("webscreen");
const capture = new captureWebsite({
   viewport: {
      width: 1920,
      height: 1080
   }
});

capture.screenshot("roxza.me", "hello.png").then(function (res) {
   console.log(res);
});

capture.screenshot("roxza.me", "roxza.png");

Parameters

Below is the list of available parameters

Parameter Description
url The url to take a screenshot of.
path File path to save
width The width of the viewport in pixels.
height The height of the viewport in pixels.

License

Webscreen is licensed under the [MIT License]. The terms of the license are as follows:

The MIT License (MIT)

Copyright (c) 2022 - Roxza

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.