Nuclear Powered Macros

    screenshotone-api-sdk
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.19 • Public • Published

    jssdk

    Build NPM package

    An official Screenshot API client for JavaScript and TypeScript.

    It takes minutes to start taking screenshots. Just sign up to get access and secret keys, import the client, and you are ready to go.

    The SDK client is synchronized with the latest screenshot API options.

    Installation

    npm install screenshotone-api-sdk --save

    Usage

    Generate a screenshot URL without executing the request. Or download the screenshot. It is up to you:

    import * as fs from 'fs';
    import * as screenshotone from 'screenshotone-api-sdk';
    
    // create API client 
    const client = new screenshotone.Client("<access key>", "<secret key>");
    
    // set up options
    const options = screenshotone.TakeOptions
        .url("https://example.com")
        .delay(3)
        .blockAds(true);    
    
    // generate URL 
    const url = client.generateTakeURL(options);
    console.log(url);
    // expected output: https://api.screenshotone.com/take?url=https%3A%2F%2Fexample.com&delay=3&block_ads=true&access_key=%3Caccess+key%3E&signature=7f3419ece2c53ed2c7923c7d5deef290d662c3643822bf69ec8259ce10b3ea61
    
    // or download the screenshot
    const imageBlob = await client.take(options);
    const buffer = Buffer.from(await imageBlob.arrayBuffer());
    fs.writeFileSync("example.png", buffer)
    // the screenshot is store in the example.png file

    License

    screenshotone/jssdk is released under the MIT license.

    Install

    npm i screenshotone-api-sdk

    DownloadsWeekly Downloads

    24

    Version

    1.0.19

    License

    MIT

    Unpacked Size

    22.3 kB

    Total Files

    7

    Last publish

    Collaborators

    • screenshotonedev