Skip to content

Commit a25730d

Browse files
committed
Docs update
1 parent 9f8e7f2 commit a25730d

File tree

2 files changed

+24
-23
lines changed

2 files changed

+24
-23
lines changed

README.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,13 @@ JavaScript applications. It runs both in Node.js and browser.
5757
#### [](#ScrapingAntClient) `new ScrapingAntClient(options)`
5858

5959

60-
| Param | Type | Default |
61-
| --- | --- | --- |
62-
| [options] | <code>object</code> | |
63-
| [options.maxRetries] | <code>number</code> | <code>8</code> |
60+
| Param | Type | Default |
61+
|----------------------------------------|---------------------|------------------|
62+
| [options] | <code>object</code> | |
63+
| [options.maxRetries] | <code>number</code> | <code>8</code> |
6464
| [options.minDelayBetweenRetriesMillis] | <code>number</code> | <code>500</code> |
65-
| [options.timeoutSecs] | <code>number</code> | <code>60</code> |
66-
| [options.apiKey] | <code>string</code> | |
65+
| [options.timeoutSecs] | <code>number</code> | <code>60</code> |
66+
| [options.apiKey] | <code>string</code> | |
6767

6868

6969
* * *
@@ -74,17 +74,18 @@ JavaScript applications. It runs both in Node.js and browser.
7474

7575
https://docs.scrapingant.com/request-response-format#available-parameters
7676

77-
| Param | Type |
78-
| --- | --- |
79-
| url | <code>string</code> |
80-
| [parameters] | <code>object</code> |
81-
| [parameters.browser] | <code>boolean</code> |
82-
| [parameters.cookies] | <code>string</code> |
83-
| [parameters.js_snippet] | <code>string</code> |
84-
| [parameters.proxy_type] | <code>string</code> |
85-
| [parameters.proxy_country] | <code>string</code> |
86-
| [parameters.wait_for_selector] | <code>string</code> |
87-
| [parameters.return_text] | <code>boolean</code> |
77+
| Param | Type |
78+
|--------------------------------|----------------------|
79+
| url | <code>string</code> |
80+
| [parameters] | <code>object</code> |
81+
| [parameters.browser] | <code>boolean</code> |
82+
| [parameters.cookies] | <code>string</code> |
83+
| [parameters.headers] | <code>object</code> |
84+
| [parameters.js_snippet] | <code>string</code> |
85+
| [parameters.proxy_type] | <code>string</code> |
86+
| [parameters.proxy_country] | <code>string</code> |
87+
| [parameters.wait_for_selector] | <code>string</code> |
88+
| [parameters.return_text] | <code>boolean</code> |
8889

8990
**IMPORTANT NOTE:** <code>parameters.js_snippet</code> will be encoded to Base64 automatically by the ScrapingAnt JS client library.
9091

@@ -101,11 +102,11 @@ because a correction by the user is needed.
101102

102103
**Properties**
103104

104-
| Name | Type | Description |
105-
| --- | --- | --- |
106-
| message | <code>string</code> | Error message returned by the API. |
107-
| statusCode | <code>number</code> | HTTP status code of the error. |
108-
| httpMethod | <code>string</code> | HTTP method of the API call. |
105+
| Name | Type | Description |
106+
|------------|---------------------|------------------------------------|
107+
| message | <code>string</code> | Error message returned by the API. |
108+
| statusCode | <code>number</code> | HTTP status code of the error. |
109+
| httpMethod | <code>string</code> | HTTP method of the API call. |
109110

110111

111112
* * *

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@scrapingant/scrapingant-client",
3-
"version": "0.2.0",
3+
"version": "0.2.1",
44
"description": "ScrapingAnt API client for JavaScript",
55
"main": "src/index.js",
66
"keywords": [

0 commit comments

Comments
 (0)