Skip to content

Commit 8e3be09

Browse files
🐛 Fix incorrect type annotation for format option in crawl().get
1 parent f28c5e1 commit 8e3be09

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

src/diffbot.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,14 +274,14 @@ declare class Diffbot {
274274
* Download a Crawlbot crawl job's results
275275
* @param {Object} options The options
276276
* @param {string} options.name Name of the crawl whose data you wish to download.
277-
* @param {format} [options.format] Request format=csv to download the extracted data in CSV format (default: json). Note that CSV files will only contain top-level fields.
277+
* @param {string} [options.format] Request format=csv to download the extracted data in CSV format (default: json). Note that CSV files will only contain top-level fields.
278278
* @param {string} [options.type] Request type=urls to retrieve the crawl URL Report (CSV).
279279
* @param {number} [options.num] Pass an integer value (e.g. num=100) to request a subset of URLs, most recently crawled first.
280280
* @returns The crawl job's results
281281
*/
282282
get: (options: {
283283
name: string;
284-
format?: any;
284+
format?: string;
285285
type?: string;
286286
num?: number;
287287
}) => any;

src/diffbot.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -553,7 +553,7 @@ class Diffbot {
553553
* Download a Crawlbot crawl job's results
554554
* @param {Object} options The options
555555
* @param {string} options.name Name of the crawl whose data you wish to download.
556-
* @param {format} [options.format] Request format=csv to download the extracted data in CSV format (default: json). Note that CSV files will only contain top-level fields.
556+
* @param {string} [options.format] Request format=csv to download the extracted data in CSV format (default: json). Note that CSV files will only contain top-level fields.
557557
* @param {string} [options.type] Request type=urls to retrieve the crawl URL Report (CSV).
558558
* @param {number} [options.num] Pass an integer value (e.g. num=100) to request a subset of URLs, most recently crawled first.
559559
* @returns The crawl job's results

0 commit comments

Comments
 (0)