@the-convocation/twitter-scraper 0.0.8 → 0.1.0

package/dist/tweets.js

@@ -1,59 +1,59 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { addApiParams, requestApi } from './api';
-import { getUserIdByScreenName } from './profile';
-import { parseTweets } from './timeline';
-import { getTweetTimeline } from './timeline-async';
-export function fetchTweets(user, maxTweets, includeReplies, cursor, auth) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (maxTweets > 200) {
-            maxTweets = 200;
-        }
-        const userIdRes = yield getUserIdByScreenName(user, auth);
-        if (!userIdRes.success) {
-            throw userIdRes.err;
-        }
-        const params = new URLSearchParams();
-        addApiParams(params, includeReplies);
-        params.set('count', `${maxTweets}`);
-        params.set('userId', userIdRes.value);
-        if (cursor != null && cursor != '') {
-            params.set('cursor', cursor);
-        }
-        const res = yield requestApi(`https://api.twitter.com/2/timeline/profile/${userIdRes.value}.json?${params.toString()}`, auth);
-        if (!res.success) {
-            throw res.err;
-        }
-        return parseTweets(res.value);
-    });
-}
-export function getTweets(user, maxTweets, includeReplies, auth) {
-    return getTweetTimeline(user, maxTweets, (q, mt, c) => {
-        return fetchTweets(q, mt, includeReplies, c, auth);
-    });
-}
-export function getTweet(id, includeReplies, auth) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const params = new URLSearchParams();
-        addApiParams(params, includeReplies);
-        const res = yield requestApi(`https://twitter.com/i/api/2/timeline/conversation/${id}.json?${params.toString()}`, auth);
-        if (!res.success) {
-            throw res.err;
-        }
-        const { tweets } = parseTweets(res.value);
-        for (const tweet of tweets) {
-            if (tweet.id === id) {
-                return tweet;
-            }
-        }
-        return null;
-    });
-}
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { addApiParams, requestApi } from './api';
+import { getUserIdByScreenName } from './profile';
+import { parseTweets } from './timeline';
+import { getTweetTimeline } from './timeline-async';
+export function fetchTweets(user, maxTweets, includeReplies, cursor, auth) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (maxTweets > 200) {
+            maxTweets = 200;
+        }
+        const userIdRes = yield getUserIdByScreenName(user, auth);
+        if (!userIdRes.success) {
+            throw userIdRes.err;
+        }
+        const params = new URLSearchParams();
+        addApiParams(params, includeReplies);
+        params.set('count', `${maxTweets}`);
+        params.set('userId', userIdRes.value);
+        if (cursor != null && cursor != '') {
+            params.set('cursor', cursor);
+        }
+        const res = yield requestApi(`https://api.twitter.com/2/timeline/profile/${userIdRes.value}.json?${params.toString()}`, auth);
+        if (!res.success) {
+            throw res.err;
+        }
+        return parseTweets(res.value);
+    });
+}
+export function getTweets(user, maxTweets, includeReplies, auth) {
+    return getTweetTimeline(user, maxTweets, (q, mt, c) => {
+        return fetchTweets(q, mt, includeReplies, c, auth);
+    });
+}
+export function getTweet(id, includeReplies, auth) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const params = new URLSearchParams();
+        addApiParams(params, includeReplies);
+        const res = yield requestApi(`https://twitter.com/i/api/2/timeline/conversation/${id}.json?${params.toString()}`, auth);
+        if (!res.success) {
+            throw res.err;
+        }
+        const { tweets } = parseTweets(res.value);
+        for (const tweet of tweets) {
+            if (tweet.id === id) {
+                return tweet;
+            }
+        }
+        return null;
+    });
+}
 //# sourceMappingURL=tweets.js.map

package/dist/types/api.d.ts

@@ -1,16 +1,16 @@
-import { TwitterGuestAuth } from './auth';
-export declare const bearerToken = "AAAAAAAAAAAAAAAAAAAAAPYXBAAAAAAACLXUNDekMxqa8h%2F40K4moUkGsoc%3DTYfbDKbT3jJPCEVnMYqilB28NHfOPqkca3qaAxGfsyKCs0wRbw";
-export declare const bearerToken2 = "AAAAAAAAAAAAAAAAAAAAANRILgAAAAAAnNwIzUejRCOuH5E6I8xnZz4puTs%3D1Zv7ttfk8LF81IUq16cHjhLTvJu4FA33AGWWjCpTnA";
-/**
- * An API result container.
- */
-export declare type RequestApiResult<T> = {
-    success: true;
-    value: T;
-} | {
-    success: false;
-    err: Error;
-};
-export declare function requestApi<T>(url: string, auth: TwitterGuestAuth): Promise<RequestApiResult<T>>;
-export declare function addApiParams(params: URLSearchParams, includeTweetReplies: boolean): URLSearchParams;
+import { TwitterGuestAuth } from './auth';
+export declare const bearerToken = "AAAAAAAAAAAAAAAAAAAAAPYXBAAAAAAACLXUNDekMxqa8h%2F40K4moUkGsoc%3DTYfbDKbT3jJPCEVnMYqilB28NHfOPqkca3qaAxGfsyKCs0wRbw";
+export declare const bearerToken2 = "AAAAAAAAAAAAAAAAAAAAANRILgAAAAAAnNwIzUejRCOuH5E6I8xnZz4puTs%3D1Zv7ttfk8LF81IUq16cHjhLTvJu4FA33AGWWjCpTnA";
+/**
+ * An API result container.
+ */
+export declare type RequestApiResult<T> = {
+    success: true;
+    value: T;
+} | {
+    success: false;
+    err: Error;
+};
+export declare function requestApi<T>(url: string, auth: TwitterGuestAuth): Promise<RequestApiResult<T>>;
+export declare function addApiParams(params: URLSearchParams, includeTweetReplies: boolean): URLSearchParams;
 //# sourceMappingURL=api.d.ts.map

package/dist/types/auth.d.ts

@@ -1,55 +1,55 @@
-/**
- * A guest authentication token manager. Automatically handles token refreshes.
- */
-export declare class TwitterGuestAuth {
-    private bearerToken;
-    private cookie?;
-    private guestToken?;
-    private guestCreatedAt?;
-    private xCsrfToken?;
-    constructor(bearerToken: string, cookie?: string, xCsrfToken?: string);
-    /**
-     * Deletes the authentication token.
-     */
-    deleteToken(): void;
-    /**
-     * Returns if the authentication state has a token.
-     * @returns `true` if the authentication state has a token; `false` otherwise.
-     */
-    hasToken(): boolean;
-    /**
-     * Returns the time that authentication was performed.
-     * @returns The time at which the authentication token was created, or `null` if it hasn't been created yet.
-     */
-    authenticatedAt(): Date | null;
-    /**
-     * Sets a cookie string for use in requests.
-     * @param value The new cookie to use in requests.
-     */
-    useCookie(value: string): void;
-    /**
-     * Sets a new CSRF token for use in requests.
-     * @param value The new CSRF token to use in requests.
-     */
-    useCsrfToken(value: string): void;
-    /**
-     * Installs the authentication information into a headers-like object. If needed, the
-     * authentication token will be updated from the API automatically.
-     * @param headers A key-value object representing a request's headers.
-     * @returns A builder that can be used to add or override other relevant data, or to
-     * complete the task.
-     */
-    installTo(headers: {
-        [key: string]: unknown;
-    }): Promise<void>;
-    /**
-     * Updates the authentication state with a new guest token from the Twitter API.
-     */
-    updateToken(): Promise<void>;
-    /**
-     * Returns if the authentication token needs to be updated or not.
-     * @returns `true` if the token needs to be updated; `false` otherwise.
-     */
-    private shouldUpdate;
-}
+/**
+ * A guest authentication token manager. Automatically handles token refreshes.
+ */
+export declare class TwitterGuestAuth {
+    private bearerToken;
+    private cookie?;
+    private guestToken?;
+    private guestCreatedAt?;
+    private xCsrfToken?;
+    constructor(bearerToken: string, cookie?: string, xCsrfToken?: string);
+    /**
+     * Deletes the authentication token.
+     */
+    deleteToken(): void;
+    /**
+     * Returns if the authentication state has a token.
+     * @returns `true` if the authentication state has a token; `false` otherwise.
+     */
+    hasToken(): boolean;
+    /**
+     * Returns the time that authentication was performed.
+     * @returns The time at which the authentication token was created, or `null` if it hasn't been created yet.
+     */
+    authenticatedAt(): Date | null;
+    /**
+     * Sets a cookie string for use in requests.
+     * @param value The new cookie to use in requests.
+     */
+    useCookie(value: string): void;
+    /**
+     * Sets a new CSRF token for use in requests.
+     * @param value The new CSRF token to use in requests.
+     */
+    useCsrfToken(value: string): void;
+    /**
+     * Installs the authentication information into a headers-like object. If needed, the
+     * authentication token will be updated from the API automatically.
+     * @param headers A key-value object representing a request's headers.
+     * @returns A builder that can be used to add or override other relevant data, or to
+     * complete the task.
+     */
+    installTo(headers: {
+        [key: string]: unknown;
+    }): Promise<void>;
+    /**
+     * Updates the authentication state with a new guest token from the Twitter API.
+     */
+    updateToken(): Promise<void>;
+    /**
+     * Returns if the authentication token needs to be updated or not.
+     * @returns `true` if the token needs to be updated; `false` otherwise.
+     */
+    private shouldUpdate;
+}
 //# sourceMappingURL=auth.d.ts.map

package/dist/types/profile.d.ts

@@ -1,67 +1,67 @@
-import { RequestApiResult } from './api';
-import { TwitterGuestAuth } from './auth';
-export interface LegacyUserRaw {
-    created_at?: string;
-    description?: string;
-    entities?: {
-        url?: {
-            urls?: {
-                expanded_url?: string;
-            }[];
-        };
-    };
-    favourites_count?: number;
-    followers_count?: number;
-    friends_count?: number;
-    id_str?: string;
-    listed_count?: number;
-    name?: string;
-    location: string;
-    pinned_tweet_ids_str?: string[];
-    profile_banner_url?: string;
-    profile_image_url_https?: string;
-    protected?: boolean;
-    screen_name?: string;
-    statuses_count?: number;
-    verified?: boolean;
-}
-/**
- * A parsed profile object.
- */
-export interface Profile {
-    avatar?: string;
-    banner?: string;
-    biography?: string;
-    birthday?: string;
-    followersCount?: number;
-    followingCount?: number;
-    friendsCount?: number;
-    isPrivate?: boolean;
-    isVerified?: boolean;
-    joined?: Date;
-    likesCount?: number;
-    listedCount?: number;
-    location: string;
-    name?: string;
-    pinnedTweetIds?: string[];
-    tweetsCount?: number;
-    url?: string;
-    userId?: string;
-    username?: string;
-    website?: string;
-}
-export interface UserRaw {
-    data: {
-        user: {
-            rest_id?: string;
-            legacy: LegacyUserRaw;
-        };
-    };
-    errors?: {
-        message: string;
-    }[];
-}
-export declare function parseProfile(user: LegacyUserRaw): Profile;
-export declare function getProfile(username: string, auth: TwitterGuestAuth): Promise<RequestApiResult<Profile>>;
-export declare function getUserIdByScreenName(screenName: string, auth: TwitterGuestAuth): Promise<RequestApiResult<string>>;
+import { RequestApiResult } from './api';
+import { TwitterGuestAuth } from './auth';
+export interface LegacyUserRaw {
+    created_at?: string;
+    description?: string;
+    entities?: {
+        url?: {
+            urls?: {
+                expanded_url?: string;
+            }[];
+        };
+    };
+    favourites_count?: number;
+    followers_count?: number;
+    friends_count?: number;
+    id_str?: string;
+    listed_count?: number;
+    name?: string;
+    location: string;
+    pinned_tweet_ids_str?: string[];
+    profile_banner_url?: string;
+    profile_image_url_https?: string;
+    protected?: boolean;
+    screen_name?: string;
+    statuses_count?: number;
+    verified?: boolean;
+}
+/**
+ * A parsed profile object.
+ */
+export interface Profile {
+    avatar?: string;
+    banner?: string;
+    biography?: string;
+    birthday?: string;
+    followersCount?: number;
+    followingCount?: number;
+    friendsCount?: number;
+    isPrivate?: boolean;
+    isVerified?: boolean;
+    joined?: Date;
+    likesCount?: number;
+    listedCount?: number;
+    location: string;
+    name?: string;
+    pinnedTweetIds?: string[];
+    tweetsCount?: number;
+    url?: string;
+    userId?: string;
+    username?: string;
+    website?: string;
+}
+export interface UserRaw {
+    data: {
+        user: {
+            rest_id?: string;
+            legacy: LegacyUserRaw;
+        };
+    };
+    errors?: {
+        message: string;
+    }[];
+}
+export declare function parseProfile(user: LegacyUserRaw): Profile;
+export declare function getProfile(username: string, auth: TwitterGuestAuth): Promise<RequestApiResult<Profile>>;
+export declare function getUserIdByScreenName(screenName: string, auth: TwitterGuestAuth): Promise<RequestApiResult<string>>;
 //# sourceMappingURL=profile.d.ts.map

package/dist/types/scraper.d.ts

@@ -1,102 +1,102 @@
-import { Profile } from './profile';
-import { SearchMode } from './search';
-import { QueryProfilesResponse, QueryTweetsResponse } from './timeline';
-import { Tweet } from './tweets';
-/**
- * An interface to Twitter's undocumented API.
- * Reusing Scraper objects is recommended to minimize the time spent authenticating unnecessarily.
- */
-export declare class Scraper {
-    private auth;
-    private authTrends;
-    /**
-     * Creates a new Scraper object. Scrapers maintain their own guest tokens for Twitter's internal API.
-     * Reusing Scraper objects is recommended to minimize the time spent authenticating unnecessarily.
-     */
-    constructor();
-    /**
-     * Fetches a Twitter profile.
-     * @param username The Twitter username of the profile to fetch, without an `@` at the beginning.
-     * @returns The requested profile.
-     */
-    getProfile(username: string): Promise<Profile>;
-    /**
-     * Fetches the user ID corresponding to the provided screen name.
-     * @param screenName The Twitter screen name of the profile to fetch.
-     * @returns The ID of the corresponding account.
-     */
-    getUserIdByScreenName(screenName: string): Promise<string>;
-    /**
-     * Fetches tweets from Twitter.
-     * @param query The search query. Any Twitter-compatible query format can be used.
-     * @param maxTweets The maximum number of tweets to return.
-     * @param includeReplies Whether or not replies should be included in the response.
-     * @param searchMode The category filter to apply to the search. Defaults to `Top`.
-     * @returns An async generator of tweets matching the provided filters.
-     */
-    searchTweets(query: string, maxTweets: number, includeReplies: boolean, searchMode?: SearchMode): AsyncGenerator<Tweet>;
-    /**
-     * Fetches profiles from Twitter.
-     * @param query The search query. Any Twitter-compatible query format can be used.
-     * @param maxProfiles The maximum number of profiles to return.
-     * @returns An async generator of tweets matching the provided filters.
-     */
-    searchProfiles(query: string, maxProfiles: number): AsyncGenerator<Profile>;
-    /**
-     * Fetches tweets from Twitter.
-     * @param query The search query. Any Twitter-compatible query format can be used.
-     * @param maxTweets The maximum number of tweets to return.
-     * @param includeReplies Whether or not replies should be included in the response.
-     * @param searchMode The category filter to apply to the search. Defaults to `Top`.
-     * @param cursor The search cursor, which can be passed into further requests for more results.
-     * @returns A page of results, containing a cursor that can be used in further requests.
-     */
-    fetchSearchTweets(query: string, maxTweets: number, includeReplies: boolean, searchMode: SearchMode, cursor?: string): Promise<QueryTweetsResponse>;
-    /**
-     * Fetches profiles from Twitter.
-     * @param query The search query. Any Twitter-compatible query format can be used.
-     * @param maxProfiles The maximum number of profiles to return.
-     * @param cursor The search cursor, which can be passed into further requests for more results.
-     * @returns A page of results, containing a cursor that can be used in further requests.
-     */
-    fetchSearchProfiles(query: string, maxProfiles: number, cursor?: string): Promise<QueryProfilesResponse>;
-    /**
-     * Fetches the current trends from Twitter.
-     * @returns The current list of trends.
-     */
-    getTrends(): Promise<string[]>;
-    /**
-     * Fetches tweets from a Twitter user.
-     * @param user The user whose tweets should be returned.
-     * @param maxTweets The maximum number of tweets to return.
-     * @param includeReplies Whether or not to include tweet replies.
-     * @returns An async generator of tweets from the provided user.
-     */
-    getTweets(user: string, maxTweets: number, includeReplies: boolean): AsyncGenerator<Tweet>;
-    /**
-     * Fetches a single tweet.
-     * @param id The ID of the tweet to fetch.
-     * @param includeReplies Whether or not to include tweet replies.
-     * @returns The request tweet, or `null` if it couldn't be fetched.
-     */
-    getTweet(id: string, includeReplies: boolean): Promise<Tweet | null>;
-    /**
-     * Returns if the scraper has a guest token. The token may not be valid.
-     * @returns `true` if the scraper has a guest token; otherwise `false`.
-     */
-    hasGuestToken(): boolean;
-    /**
-     * Sets the optional cookie to be used in requests.
-     * @param cookie The cookie to be used in requests.
-     * @returns This scraper instance.
-     */
-    withCookie(cookie: string): Scraper;
-    /**
-     * Sets the optional CSRF token to be used in requests.
-     * @param token The CSRF token to be used in requests.
-     * @returns This scraper instance.
-     */
-    withXCsrfToken(token: string): Scraper;
-    private handleResponse;
-}
+import { Profile } from './profile';
+import { SearchMode } from './search';
+import { QueryProfilesResponse, QueryTweetsResponse } from './timeline';
+import { Tweet } from './tweets';
+/**
+ * An interface to Twitter's undocumented API.
+ * Reusing Scraper objects is recommended to minimize the time spent authenticating unnecessarily.
+ */
+export declare class Scraper {
+    private auth;
+    private authTrends;
+    /**
+     * Creates a new Scraper object. Scrapers maintain their own guest tokens for Twitter's internal API.
+     * Reusing Scraper objects is recommended to minimize the time spent authenticating unnecessarily.
+     */
+    constructor();
+    /**
+     * Fetches a Twitter profile.
+     * @param username The Twitter username of the profile to fetch, without an `@` at the beginning.
+     * @returns The requested profile.
+     */
+    getProfile(username: string): Promise<Profile>;
+    /**
+     * Fetches the user ID corresponding to the provided screen name.
+     * @param screenName The Twitter screen name of the profile to fetch.
+     * @returns The ID of the corresponding account.
+     */
+    getUserIdByScreenName(screenName: string): Promise<string>;
+    /**
+     * Fetches tweets from Twitter.
+     * @param query The search query. Any Twitter-compatible query format can be used.
+     * @param maxTweets The maximum number of tweets to return.
+     * @param includeReplies Whether or not replies should be included in the response.
+     * @param searchMode The category filter to apply to the search. Defaults to `Top`.
+     * @returns An async generator of tweets matching the provided filters.
+     */
+    searchTweets(query: string, maxTweets: number, includeReplies: boolean, searchMode?: SearchMode): AsyncGenerator<Tweet>;
+    /**
+     * Fetches profiles from Twitter.
+     * @param query The search query. Any Twitter-compatible query format can be used.
+     * @param maxProfiles The maximum number of profiles to return.
+     * @returns An async generator of tweets matching the provided filters.
+     */
+    searchProfiles(query: string, maxProfiles: number): AsyncGenerator<Profile>;
+    /**
+     * Fetches tweets from Twitter.
+     * @param query The search query. Any Twitter-compatible query format can be used.
+     * @param maxTweets The maximum number of tweets to return.
+     * @param includeReplies Whether or not replies should be included in the response.
+     * @param searchMode The category filter to apply to the search. Defaults to `Top`.
+     * @param cursor The search cursor, which can be passed into further requests for more results.
+     * @returns A page of results, containing a cursor that can be used in further requests.
+     */
+    fetchSearchTweets(query: string, maxTweets: number, includeReplies: boolean, searchMode: SearchMode, cursor?: string): Promise<QueryTweetsResponse>;
+    /**
+     * Fetches profiles from Twitter.
+     * @param query The search query. Any Twitter-compatible query format can be used.
+     * @param maxProfiles The maximum number of profiles to return.
+     * @param cursor The search cursor, which can be passed into further requests for more results.
+     * @returns A page of results, containing a cursor that can be used in further requests.
+     */
+    fetchSearchProfiles(query: string, maxProfiles: number, cursor?: string): Promise<QueryProfilesResponse>;
+    /**
+     * Fetches the current trends from Twitter.
+     * @returns The current list of trends.
+     */
+    getTrends(): Promise<string[]>;
+    /**
+     * Fetches tweets from a Twitter user.
+     * @param user The user whose tweets should be returned.
+     * @param maxTweets The maximum number of tweets to return.
+     * @param includeReplies Whether or not to include tweet replies.
+     * @returns An async generator of tweets from the provided user.
+     */
+    getTweets(user: string, maxTweets: number, includeReplies: boolean): AsyncGenerator<Tweet>;
+    /**
+     * Fetches a single tweet.
+     * @param id The ID of the tweet to fetch.
+     * @param includeReplies Whether or not to include tweet replies.
+     * @returns The request tweet, or `null` if it couldn't be fetched.
+     */
+    getTweet(id: string, includeReplies: boolean): Promise<Tweet | null>;
+    /**
+     * Returns if the scraper has a guest token. The token may not be valid.
+     * @returns `true` if the scraper has a guest token; otherwise `false`.
+     */
+    hasGuestToken(): boolean;
+    /**
+     * Sets the optional cookie to be used in requests.
+     * @param cookie The cookie to be used in requests.
+     * @returns This scraper instance.
+     */
+    withCookie(cookie: string): Scraper;
+    /**
+     * Sets the optional CSRF token to be used in requests.
+     * @param token The CSRF token to be used in requests.
+     * @returns This scraper instance.
+     */
+    withXCsrfToken(token: string): Scraper;
+    private handleResponse;
+}
 //# sourceMappingURL=scraper.d.ts.map

package/dist/types/search.d.ts

@@ -1,19 +1,19 @@
-import { TwitterGuestAuth } from './auth';
-import { Profile } from './profile';
-import { QueryProfilesResponse, QueryTweetsResponse } from './timeline';
-import { Tweet } from './tweets';
-/**
- * The categories that can be used in Twitter searches.
- */
-export declare enum SearchMode {
-    Top = 0,
-    Latest = 1,
-    Photos = 2,
-    Videos = 3,
-    Users = 4
-}
-export declare function searchTweets(query: string, maxTweets: number, includeReplies: boolean, searchMode: SearchMode, auth: TwitterGuestAuth): AsyncGenerator<Tweet>;
-export declare function searchProfiles(query: string, maxProfiles: number, auth: TwitterGuestAuth): AsyncGenerator<Profile>;
-export declare function fetchSearchTweets(query: string, maxTweets: number, includeReplies: boolean, searchMode: SearchMode, auth: TwitterGuestAuth, cursor?: string): Promise<QueryTweetsResponse>;
-export declare function fetchSearchProfiles(query: string, maxProfiles: number, auth: TwitterGuestAuth, cursor?: string): Promise<QueryProfilesResponse>;
+import { TwitterGuestAuth } from './auth';
+import { Profile } from './profile';
+import { QueryProfilesResponse, QueryTweetsResponse } from './timeline';
+import { Tweet } from './tweets';
+/**
+ * The categories that can be used in Twitter searches.
+ */
+export declare enum SearchMode {
+    Top = 0,
+    Latest = 1,
+    Photos = 2,
+    Videos = 3,
+    Users = 4
+}
+export declare function searchTweets(query: string, maxTweets: number, includeReplies: boolean, searchMode: SearchMode, auth: TwitterGuestAuth): AsyncGenerator<Tweet>;
+export declare function searchProfiles(query: string, maxProfiles: number, auth: TwitterGuestAuth): AsyncGenerator<Profile>;
+export declare function fetchSearchTweets(query: string, maxTweets: number, includeReplies: boolean, searchMode: SearchMode, auth: TwitterGuestAuth, cursor?: string): Promise<QueryTweetsResponse>;
+export declare function fetchSearchProfiles(query: string, maxProfiles: number, auth: TwitterGuestAuth, cursor?: string): Promise<QueryProfilesResponse>;
 //# sourceMappingURL=search.d.ts.map