rettiwt-api 2.3.1 → 2.4.0

package/dist/services/public/TweetService.d.ts

@@ -22,6 +22,23 @@ export declare class TweetService extends FetcherService {
      * @param id - The id of the target tweet.
      * @returns The details of a single tweet with the given tweet id.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the details of the tweet with the id '12345678'
+     * rettiwt.tweet.details('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     details(id: string): Promise<Tweet>;
@@ -33,6 +50,25 @@ export declare class TweetService extends FetcherService {
      * @param cursor - The cursor to the batch of tweets to fetch.
      * @returns The list of tweets that match the given filter.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the most recent 5 tweets from user 'user1'
+     * rettiwt.tweet.search({ fromUsers: ['user1'] }, 5)
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
+     * @remarks For details about available filters, refer to {@link TweetFilter}
+     *
      * @public
      */
     search(query: TweetFilter, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
@@ -44,6 +80,23 @@ export declare class TweetService extends FetcherService {
      * @param cursor - The cursor to the batch of tweets to fetch.
      * @returns The list tweets present in the given list.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the most recent 100 tweets of the Twitter list with id '12345678'
+     * rettiwt.tweet.list('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @remarks Due a bug in Twitter API, the count is ignored when no cursor is provided and defaults to 100.
      */
     list(listId: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
@@ -55,6 +108,23 @@ export declare class TweetService extends FetcherService {
      * @param cursor - The cursor to the batch of favoriters to fetch.
      * @returns The list of users who liked the given tweet.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the most recent 100 likers of the Tweet with id '12345678'
+     * rettiwt.tweet.favoriters('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     favoriters(tweetId: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
@@ -66,6 +136,23 @@ export declare class TweetService extends FetcherService {
      * @param cursor - The cursor to the batch of retweeters to fetch.
      * @returns The list of users who retweeted the given tweet.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the most recent 100 retweeters of the Tweet with id '12345678'
+     * rettiwt.tweet.retweeters('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     retweeters(tweetId: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
@@ -75,6 +162,23 @@ export declare class TweetService extends FetcherService {
      * @param tweetText - The text to be posted, length must be \<= 280 characters.
      * @returns Whether posting was successful or not.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Posting a tweet to twitter
+     * rettiwt.tweet.tweet('Hello World!')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     tweet(tweetText: string): Promise<boolean>;
@@ -84,6 +188,23 @@ export declare class TweetService extends FetcherService {
      * @param tweetId - The id of the tweet to be favorited.
      * @returns Whether favoriting was successful or not.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Liking the Tweet with id '12345678'
+     * rettiwt.tweet.favorite('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     favorite(tweetId: string): Promise<boolean>;
@@ -93,6 +214,23 @@ export declare class TweetService extends FetcherService {
      * @param tweetId - The id of the tweet with the given id.
      * @returns Whether retweeting was successful or not.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Retweeting the Tweet with id '12345678'
+     * rettiwt.tweet.retweet('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     retweet(tweetId: string): Promise<boolean>;

package/dist/services/public/TweetService.js

@@ -77,6 +77,23 @@ var TweetService = /** @class */ (function (_super) {
      * @param id - The id of the target tweet.
      * @returns The details of a single tweet with the given tweet id.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the details of the tweet with the id '12345678'
+     * rettiwt.tweet.details('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     TweetService.prototype.details = function (id) {
@@ -100,6 +117,25 @@ var TweetService = /** @class */ (function (_super) {
      * @param cursor - The cursor to the batch of tweets to fetch.
      * @returns The list of tweets that match the given filter.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the most recent 5 tweets from user 'user1'
+     * rettiwt.tweet.search({ fromUsers: ['user1'] }, 5)
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
+     * @remarks For details about available filters, refer to {@link TweetFilter}
+     *
      * @public
      */
     TweetService.prototype.search = function (query, count, cursor) {
@@ -129,6 +165,23 @@ var TweetService = /** @class */ (function (_super) {
      * @param cursor - The cursor to the batch of tweets to fetch.
      * @returns The list tweets present in the given list.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the most recent 100 tweets of the Twitter list with id '12345678'
+     * rettiwt.tweet.list('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @remarks Due a bug in Twitter API, the count is ignored when no cursor is provided and defaults to 100.
      */
     TweetService.prototype.list = function (listId, count, cursor) {
@@ -158,6 +211,23 @@ var TweetService = /** @class */ (function (_super) {
      * @param cursor - The cursor to the batch of favoriters to fetch.
      * @returns The list of users who liked the given tweet.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the most recent 100 likers of the Tweet with id '12345678'
+     * rettiwt.tweet.favoriters('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     TweetService.prototype.favoriters = function (tweetId, count, cursor) {
@@ -185,6 +255,23 @@ var TweetService = /** @class */ (function (_super) {
      * @param cursor - The cursor to the batch of retweeters to fetch.
      * @returns The list of users who retweeted the given tweet.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the most recent 100 retweeters of the Tweet with id '12345678'
+     * rettiwt.tweet.retweeters('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     TweetService.prototype.retweeters = function (tweetId, count, cursor) {
@@ -210,6 +297,23 @@ var TweetService = /** @class */ (function (_super) {
      * @param tweetText - The text to be posted, length must be \<= 280 characters.
      * @returns Whether posting was successful or not.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Posting a tweet to twitter
+     * rettiwt.tweet.tweet('Hello World!')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     TweetService.prototype.tweet = function (tweetText) {
@@ -231,6 +335,23 @@ var TweetService = /** @class */ (function (_super) {
      * @param tweetId - The id of the tweet to be favorited.
      * @returns Whether favoriting was successful or not.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Liking the Tweet with id '12345678'
+     * rettiwt.tweet.favorite('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     TweetService.prototype.favorite = function (tweetId) {
@@ -252,6 +373,23 @@ var TweetService = /** @class */ (function (_super) {
      * @param tweetId - The id of the tweet with the given id.
      * @returns Whether retweeting was successful or not.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Retweeting the Tweet with id '12345678'
+     * rettiwt.tweet.retweet('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     TweetService.prototype.retweet = function (tweetId) {

package/dist/services/public/TweetService.js.map

@@ -1 +1 @@
-{"version":3,"file":"TweetService.js","sourceRoot":"","sources":["../../../src/services/public/TweetService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,WAAW;AACX,6CAA0D;AAE1D,WAAW;AACX,6DAA4D;AAQ5D;;;;GAIG;AACH;IAAkC,gCAAc;IAC/C;;;;OAIG;IACH,sBAAmB,MAAsB;eACxC,kBAAM,MAAM,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACU,8BAAO,GAApB,UAAqB,EAAU;;;;;4BAEjB,qBAAM,IAAI,CAAC,KAAK,CAAQ,4BAAa,CAAC,aAAa,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAA;;wBAAvE,IAAI,GAAG,SAAgE;wBAE7E,sBAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAC;;;;KACpB;IAED;;;;;;;;;OASG;IACU,6BAAM,GAAnB,UAAoB,KAAkB,EAAE,KAAc,EAAE,MAAe;;;;;4BAEzD,qBAAM,IAAI,CAAC,KAAK,CAAQ,4BAAa,CAAC,YAAY,EAAE;4BAChE,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,oDAAoD;wBACpD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAjE,CAAiE,CAAC,CAAC;wBAE5F,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;OASG;IACU,2BAAI,GAAjB,UAAkB,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAEnD,qBAAM,IAAI,CAAC,KAAK,CAAQ,4BAAa,CAAC,WAAW,EAAE;4BAC/D,EAAE,EAAE,MAAM;4BACV,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,oDAAoD;wBACpD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAjE,CAAiE,CAAC,CAAC;wBAE5F,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;OASG;IACU,iCAAU,GAAvB,UAAwB,OAAe,EAAE,KAAc,EAAE,MAAe;;;;;4BAE1D,qBAAM,IAAI,CAAC,KAAK,CAAO,4BAAa,CAAC,gBAAgB,EAAE;4BACnE,EAAE,EAAE,OAAO;4BACX,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;OASG;IACU,iCAAU,GAAvB,UAAwB,OAAe,EAAE,KAAc,EAAE,MAAe;;;;;4BAE1D,qBAAM,IAAI,CAAC,KAAK,CAAO,4BAAa,CAAC,gBAAgB,EAAE;4BACnE,EAAE,EAAE,OAAO;4BACX,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;OAOG;IACU,4BAAK,GAAlB,UAAmB,SAAiB;;;;;4BAEtB,qBAAM,IAAI,CAAC,IAAI,CAAC,4BAAa,CAAC,YAAY,EAAE,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,EAAA;;wBAA5E,IAAI,GAAG,SAAqE;wBAElF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;OAOG;IACU,+BAAQ,GAArB,UAAsB,OAAe;;;;;4BAEvB,qBAAM,IAAI,CAAC,IAAI,CAAC,4BAAa,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAA;;wBAArE,IAAI,GAAG,SAA8D;wBAE3E,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;OAOG;IACU,8BAAO,GAApB,UAAqB,OAAe;;;;;4BAEtB,qBAAM,IAAI,CAAC,IAAI,CAAC,4BAAa,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAA;;wBAArE,IAAI,GAAG,SAA8D;wBAE3E,sBAAO,IAAI,EAAC;;;;KACZ;IACF,mBAAC;AAAD,CAAC,AA/JD,CAAkC,+BAAc,GA+J/C;AA/JY,oCAAY"}
+{"version":3,"file":"TweetService.js","sourceRoot":"","sources":["../../../src/services/public/TweetService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,WAAW;AACX,6CAA0D;AAE1D,WAAW;AACX,6DAA4D;AAQ5D;;;;GAIG;AACH;IAAkC,gCAAc;IAC/C;;;;OAIG;IACH,sBAAmB,MAAsB;eACxC,kBAAM,MAAM,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,8BAAO,GAApB,UAAqB,EAAU;;;;;4BAEjB,qBAAM,IAAI,CAAC,KAAK,CAAQ,4BAAa,CAAC,aAAa,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAA;;wBAAvE,IAAI,GAAG,SAAgE;wBAE7E,sBAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAC;;;;KACpB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACU,6BAAM,GAAnB,UAAoB,KAAkB,EAAE,KAAc,EAAE,MAAe;;;;;4BAEzD,qBAAM,IAAI,CAAC,KAAK,CAAQ,4BAAa,CAAC,YAAY,EAAE;4BAChE,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,oDAAoD;wBACpD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAjE,CAAiE,CAAC,CAAC;wBAE5F,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,2BAAI,GAAjB,UAAkB,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAEnD,qBAAM,IAAI,CAAC,KAAK,CAAQ,4BAAa,CAAC,WAAW,EAAE;4BAC/D,EAAE,EAAE,MAAM;4BACV,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,oDAAoD;wBACpD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAjE,CAAiE,CAAC,CAAC;wBAE5F,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,iCAAU,GAAvB,UAAwB,OAAe,EAAE,KAAc,EAAE,MAAe;;;;;4BAE1D,qBAAM,IAAI,CAAC,KAAK,CAAO,4BAAa,CAAC,gBAAgB,EAAE;4BACnE,EAAE,EAAE,OAAO;4BACX,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,iCAAU,GAAvB,UAAwB,OAAe,EAAE,KAAc,EAAE,MAAe;;;;;4BAE1D,qBAAM,IAAI,CAAC,KAAK,CAAO,4BAAa,CAAC,gBAAgB,EAAE;4BACnE,EAAE,EAAE,OAAO;4BACX,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,4BAAK,GAAlB,UAAmB,SAAiB;;;;;4BAEtB,qBAAM,IAAI,CAAC,IAAI,CAAC,4BAAa,CAAC,YAAY,EAAE,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,EAAA;;wBAA5E,IAAI,GAAG,SAAqE;wBAElF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,+BAAQ,GAArB,UAAsB,OAAe;;;;;4BAEvB,qBAAM,IAAI,CAAC,IAAI,CAAC,4BAAa,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAA;;wBAArE,IAAI,GAAG,SAA8D;wBAE3E,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,8BAAO,GAApB,UAAqB,OAAe;;;;;4BAEtB,qBAAM,IAAI,CAAC,IAAI,CAAC,4BAAa,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAA;;wBAArE,IAAI,GAAG,SAA8D;wBAE3E,sBAAO,IAAI,EAAC;;;;KACZ;IACF,mBAAC;AAAD,CAAC,AAzSD,CAAkC,+BAAc,GAyS/C;AAzSY,oCAAY"}

package/dist/services/public/UserService.d.ts

@@ -21,6 +21,40 @@ export declare class UserService extends FetcherService {
      * @param id - The username/id of the target user.
      * @returns The details of the given user.
      *
+     * @example Fetching the details of the Twitter user with username 'user1'
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the details of the User with username 'user1'
+     * rettiwt.user.details('user1')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
+     * @example Fetching the details of the Twitter user with id '12345678'
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the details of the User with id '12345678'
+     * rettiwt.user.details('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     details(id: string): Promise<User>;
@@ -32,6 +66,23 @@ export declare class UserService extends FetcherService {
      * @param cursor - The cursor to the batch of following to fetch.
      * @returns The list of users followed by the target user.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the first 100 following of the User with id '12345678'
+     * rettiwt.user.following('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     following(userId: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
@@ -43,6 +94,23 @@ export declare class UserService extends FetcherService {
      * @param cursor - The cursor to the batch of followers to fetch.
      * @returns The list of users following the target user.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the first 100 followers of the User with id '12345678'
+     * rettiwt.user.followers('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     followers(userId: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
@@ -54,6 +122,23 @@ export declare class UserService extends FetcherService {
      * @param cursor - The cursor to the batch of likes to fetch.
      * @returns The list of tweets liked by the target user.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the most recent 100 liked Tweets of the User with id '12345678'
+     * rettiwt.user.likes('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     likes(userId: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
@@ -65,6 +150,23 @@ export declare class UserService extends FetcherService {
      * @param cursor - The cursor to the batch of timeline items to fetch.
      * @returns The timeline of the target user.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the first 20 timeline tweets of the User with id '12345678'
+     * rettiwt.user.timeline('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @remarks
      * - If the target user has a pinned tweet, the returned timeline has one item extra and this is always the pinned tweet.
      * - If timeline is fetched without authenticating, then the most popular tweets of the target user are returned instead.
@@ -80,6 +182,23 @@ export declare class UserService extends FetcherService {
      * @param cursor - The cursor to the batch of replies to fetch.
      * @returns The reply timeline of the target user.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the first 100 timeline replies of the User with id '12345678'
+     * rettiwt.user.replies('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @remarks If the target user has a pinned tweet, the returned reply timeline has one item extra and this is always the pinned tweet.
      *
      * @public