twitter-buddy - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

lib/index.js

@@ -43,4 +43,4 @@ 'use strict'
         this._cli = cli;
-        this._csv = csv || false;
-        this._json = json || false;
+        this._csv = false || csv;
+        this._json = false || json;
         this._timeout = 0 || timeout;
@@ -47,0 +47,0 @@ this._spinner = cli ? ora('Twitter Scraper Started').start() : '';

package.json

 {
   "name": "twitter-buddy",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Twitter Scraper (Web Based API). You can scrape followers, tweets, favorites from the user profile and retweeted by, liked by and comments from a tweet.",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -87,4 +87,5 @@
 $ twitter-buddy followers realDonaldTrump -u TWITTER_USERNAME -p TWITTER_PASSWORD -n 2000
+
+CSV file saved: /{FOLDER_PATH}/followers_1571390379072_realDonaldTrump.csv
 ```
-**CSV file saved: /{FOLDER_PATH}/followers_1571390379072_realDonaldTrump.csv**
 
@@ -95,4 +96,5 @@ **Example 2**
 $ twitter-buddy tweets realDonaldTrump -u TWITTER_USERNAME -p TWITTER_PASSWORD -n 1000
+
+CSV file saved: /{FOLDER_PATH}/tweets_1571390379072_realDonaldTrump.csv
 ```
-**CSV file saved: /{FOLDER_PATH}/tweets_1571390379072_realDonaldTrump.csv**
 
@@ -103,7 +105,28 @@ **Example 3**
 $ twitter-buddy retweetedBy 1183796209942695938 -u TWITTER_USERNAME -p TWITTER_PASSWORD -n 100
+
+CSV file saved: /{FOLDER_PATH}/retweetedBy_1571390379072_1183796209942695938.csv
 ```
-**CSV file saved: /{FOLDER_PATH}/retweetedBy_1571390379072_1183796209942695938.csv**
 
 ## Module
 
+### Options
+```
+{
+    // Twitter username
+    username: {string},
+    
+    // Twitter password
+    password: {string},
+    
+    //If {true} then event emitter will be enabled, you won't be able to use promise
+    event: {boolean},
+    
+    //Timeout between requests, is usefull if the 'rate limit' error was received
+    timeout: {int}
+    
+    //Https Proxy, for example 127.0.0.1:8000
+    proxy: {string}
+    
+}
+```
 ### Promise
@@ -118,4 +141,5 @@ ```
             password:'YOUR_TWITTER_PASSWORD',
-            //session_path: 'CUSTOM_SESSION_PATH',
-            //proxy: 'HTTPS PROXY'
+            //event: {boolean} Enable event emitter
+            //timeout: {int} Timeout between requests
+            //proxy: {string} Https proxy, ex: 127.0.0.1:8080
         });
@@ -182,8 +206,8 @@
 let bot = new twitterScraper({
-      username:'YOUR_TWITTER_USERNAME', 
-      password:'YOUR_TWITTER_PASSWORD',
-      event: true // Enable event emitter
-      //session_path: 'CUSTOM_SESSION_PATH',
-      //proxy: 'HTTPS PROXY'
-  });
+    username:'YOUR_TWITTER_USERNAME', 
+    password:'YOUR_TWITTER_PASSWORD',
+    event: true, // Enable event emitter
+    //timeout: {int} Timeout between requests
+    //proxy: {string} Https proxy, ex: 127.0.0.1:8080
+ });
 
@@ -190,0 +214,0 @@

No alert changes

Improved metrics

Total package byte prevSize

47143

increased by1.1%

Number of lines in readme file

231

increased by11.59%

No dependency changes