zenrows 1.2.2 → 1.3.0

package/README.md

@@ -86,6 +86,37 @@ You can also pass optional parameters and headers; the list above is a reference
 
 Sending headers to the target URL will overwrite our defaults. Be careful when doing it and contact us if there is any problem.
 
+### POST Requests
+
+The SDK also offers POST requests by calling the `client.post` method. It can receive a new parameter `data` that represents the data sent in, for example, a form. 
+
+```javascript
+const { ZenRows } = require('zenrows', { retries: 1 });
+
+const apiKey = 'YOUR-API-KEY';
+const url = 'https://httpbin.org/anything';
+
+(async () => {
+    const client = new ZenRows(apiKey);
+
+    const { data } = await client.post(url, {
+        // The same params as in GET requests
+    }, {
+        data: new URLSearchParams({
+            'key1': 'value1',
+            'key2': 'value2',
+        }).toString(),
+    });
+
+    console.log(data);
+    /*
+        ...
+        form: { key1: 'value1', key2: 'value2' },
+        ...
+    */
+})();
+```
+
 ### Concurrency
 
 To limit the concurrency, it uses [fastq](https://github.com/mcollina/fastq), which will simultaneously send a maximum of requests. The concurrency is determined by the plan you are in, so take a look at the [pricing](https://www.zenrows.com/pricing) and set it accordingly. Take into account that each client instance will have its own limit, meaning that two different scripts will not share it, and 429 (Too Many Requests) errors might arise.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { AxiosPromise } from 'axios';
+import { AxiosPromise, Method } from 'axios';
 import * as fastq from 'fastq';
 interface ClientConfig {
     concurrency?: number;
@@ -28,13 +28,19 @@ declare class ZenRows {
     readonly clientConfig: ClientConfig;
     readonly queue: fastq.queueAsPromised<{
         url: string;
+        method?: Method | undefined;
         config?: Config | undefined;
         headers: Headers;
+        data?: any;
     }, import("axios").AxiosResponse<any>>;
     constructor(apiKey: string, clientConfig?: ClientConfig);
     get(url: string, config?: Config, { headers }?: {
         headers?: Headers;
     }): AxiosPromise;
+    post(url: string, config?: Config, { headers, data }?: {
+        headers?: Headers;
+        data?: any;
+    }): AxiosPromise;
     private worker;
     private applyRetries;
 }

package/dist/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZenRows = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
 const axios_1 = require("axios");
 const axios_retry_1 = require("axios-retry");
 const fastq = require("fastq");
@@ -17,13 +18,18 @@ class ZenRows {
     get(url, config, { headers = {} } = {}) {
         return this.queue.push({ url, config, headers });
     }
-    worker({ url, config, headers }) {
+    post(url, config, { headers = {}, data = {} } = {}) {
+        return this.queue.push({ url, method: 'POST', config, headers, data });
+    }
+    worker({ url, method = 'GET', config, headers, data }) {
         const params = Object.assign(Object.assign({}, config), { url, apikey: this.apiKey });
         const finalHeaders = Object.assign({ 'User-Agent': `zenrows/${version_1.VERSION} node` }, headers);
         const axiosRequestConfig = {
             baseURL: API_URL,
+            method,
             params,
             headers: finalHeaders,
+            data,
         };
         if (headers && Object.keys(headers).length) {
             params.custom_headers = true;

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.2.2";
+export declare const VERSION = "1.3.0";

package/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '1.2.2';
+exports.VERSION = '1.3.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zenrows",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "ZenRows Node SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",