Add limit prop to config.

Author: lewisdonovan

README.md

@@ -147,6 +147,11 @@ Whether or not Puppeteer should run in [headless mode](https://www.browserstack.
 
 Defaults to `true`
 
+#### limit
+The total number of articles that you would like to be returned. Please note that with higher numbers, the actual returned number may be lower. Typically the max is `99`, but it varies depending on many variables in Puppeteer (such as rate limiting, network conditions etc.). 
+
+Defaults to `99`
+
 ## TypeScript 💙
 Google News Scraper includes full [TypeScript](https://typescriptlang.org/) definitions. 
 

src/index.ts

@@ -24,7 +24,8 @@ const googleNewsScraper = async (userConfig: GNSUserConfig) => {
       puppeteerHeadlessMode: true,
       logLevel: 'error',
       timeframe: '7d',
-      queryVars: {},
+      queryVars: {}, 
+      limit: 99
     },
     ...userConfig,
   } as GNSConfig;
@@ -133,7 +134,8 @@ const googleNewsScraper = async (userConfig: GNSUserConfig) => {
   await page.close();
   await browser.close()
 
-  return results.filter(result => result.title)
+  const filtered = results.filter(result => result.title);
+  return config.limit < results.length ? filtered.slice(0, config.limit) : filtered;
 
 }
 

src/types.ts

@@ -18,6 +18,7 @@ export type GNSUserConfig = SearchParams & {
   logLevel?: LogLevel;
   queryVars?: QueryVars;
   filterWords?: string[];
+  limit?: number;
 };
 
 export type GNSConfig = SearchParams & {
@@ -29,6 +30,7 @@ export type GNSConfig = SearchParams & {
   logLevel: LogLevel;
   queryVars: QueryVars;
   filterWords?: string[];
+  limit: number;
 };
 
 export type Article = {