screenshotlayer-node/README.md

screenshotlayer api wrapper

# screenshotlayer-node (Screenshotlayer Node Rest API)
[![Stackoverflow Thread](https://img.shields.io/badge/stackoverflow-screenshotlayer--node--api-yellowgreen.svg)](https://stackoverflow.com/search?q=nodejs-screenshotlayer-node)

This API supported Screenshotlayer standard REST API that accepts/returns JSON requests. Here is the [API reference](https://screenshotlayer.com/documentation)

You can find [examples of JavaScript and TypeScript](https://github.com/vijaypatoliya/screenshotlayer-node/tree/master/examples). This will help you for faster implementation of Screenshotlayer APIs.

##### It does supports EcmaScript 5, EcmaScript 6,  EcmaScript 8, TypeScript, async-await, Promises, Callback!!!

##### It does also supports for AWS Lambda like serverless cloud function call.

##### It supports pure JSON response.

##### A method support Promise and Callback both.

##### Please Feel free to create issue for any help!

##### All developers/contributors are requested to open Pull Request/Merge Request on develop branch. 

##### Please make sure Test Cases be passed. 

## Get started

Using the Screenshotlayer API wrapper for Node.js is really simple.

Given that you already have a Node.js project with NPM setup just follow these steps:

## Installation
```bash
npm install screenshotlayer-node --save
```

## Pull Request
- Contributors can send their Pull Request to `develop` branch.
- Kindly validate test cases & linting before opening new PR.

## Do you need an expert?
Are you finding a developer or team for your world-class enterprise product development? If yes, please send email to. Submit your project request [here](mailto:osi.vijay@gmail.com). Originally by [Vijay Patoliya](https://github.com/vijaypatoliya).


## Configuration Using JavaScript

```bash
export SSLAYER_CLIENT_ACCESS_KEY=API_ACCESS_KEY
```

```js
var screenshotlayer = require('screenshotlayer-node')('YOUR_ACCESS_KEY');
```

## Configuration Using TypeScript
```js
import * as ScreenShotLayerAPI from 'screenshotlayer-node';
const sslayer = new ScreenShotLayerAPI();
sslayer.setApiKey('YOUR_ACCESS_KEY');
```


Originally by [Vijay Patoliya](https://github.com/vijaypatoliya) (osi.vijay@gmail.com).

 
## Example

#### Capture a snapshot
```javascript
  sslayer.setApiKey(clientAccessKey);
  var data = {
    url: 'https://www.google.com'
  };
  try {
    var response = sslayer.application.captureSnapshot(data);
  } catch (error) {
    return;
  }
```

**following code define how to save image file using above response data**
```javascript
  var pathToSave = 'path/to/save';
  var imageName = 'image';
  var extension = response.imageType;
  var fileName = pathToSave + '/' + imageName + '.' + extension;
  var wstream = fs.createWriteStream(fileName);
  var bufferString = Buffer.from(JSON.parse(response.imageBufferData).data);
  wstream.write(bufferString);
  wstream.on('error', (err) => {
    console.log(err);
    wstream.end();
  });
  console.log('created image: ', fileName);
```