Merge pull request #477 from Rishikant181/dev

Fixed documentation for stream
Rishikant181 · Feb 27, 2024 · f820aa5 · f820aa5
2 parents e506369 + 744cd78
commit f820aa5
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -32,6 +32,7 @@ Rettiwt-API can be used with or without logging in to Twitter. As such, the two
     -   Tweet Favoriters (likes)
     -   Tweet Retweeters (retweets)
     -   Tweet Search
+    -   Tweet Stream
     -   Tweet List
     -   User Details
     -   User Followers

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "rettiwt-api",
-	"version": "2.6.1",
+	"version": "2.6.2",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"description": "An API for fetching data from TwitterAPI, without any rate limits!",

diff --git a/src/services/public/TweetService.ts b/src/services/public/TweetService.ts
@@ -118,7 +118,7 @@ export class TweetService extends FetcherService {
 	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
 	 *
 	 * // Streaming all upcoming tweets from user 'user1'
-	 * async () => {
+	 * (async () => {
 	 * 	try {
 	 * 		for await (const tweet of rettiwt.tweet.stream({ fromUsers: ['user1'] }, 1000)) {
 	 * 			console.log(tweet.fullText);
@@ -127,7 +127,7 @@ export class TweetService extends FetcherService {
 	 * 	catch (err) {
 	 * 		console.log(err);
 	 * 	}
-	 * }();
+	 * })();
 	 * ```
 	 *
 	 * @public