twitter-api-v2
Version:
Strongly typed, full-featured, light, versatile yet powerful Twitter API v1.1 and v2 client for Node.js.
38 lines (37 loc) • 1.96 kB
TypeScript
import TwitterPaginator from './TwitterPaginator';
import { TwitterResponse, TweetV1, TweetV1TimelineResult, TweetV1TimelineParams, TweetV1UserTimelineParams, ListStatusesV1Params } from '../types';
/** A generic TwitterPaginator able to consume TweetV1 timelines. */
declare abstract class TweetTimelineV1Paginator<TResult extends TweetV1TimelineResult, TParams extends TweetV1TimelineParams, TShared = any> extends TwitterPaginator<TResult, TParams, TweetV1, TShared> {
protected hasFinishedFetch: boolean;
protected refreshInstanceFromResult(response: TwitterResponse<TResult>, isNextPage: true): void;
protected getNextQueryParams(maxResults?: number): {
max_results?: number | undefined;
} & Partial<TParams> & {
max_id: string;
};
protected getPageLengthFromRequest(result: TwitterResponse<TResult>): number;
protected isFetchLastOver(result: TwitterResponse<TResult>): boolean;
protected canFetchNextPage(result: TResult): boolean;
protected getItemArray(): TResult;
/**
* Tweets returned by paginator.
*/
get tweets(): TResult;
get done(): boolean;
}
export declare class HomeTimelineV1Paginator extends TweetTimelineV1Paginator<TweetV1TimelineResult, TweetV1TimelineParams> {
protected _endpoint: string;
}
export declare class MentionTimelineV1Paginator extends TweetTimelineV1Paginator<TweetV1TimelineResult, TweetV1TimelineParams> {
protected _endpoint: string;
}
export declare class UserTimelineV1Paginator extends TweetTimelineV1Paginator<TweetV1TimelineResult, TweetV1UserTimelineParams> {
protected _endpoint: string;
}
export declare class ListTimelineV1Paginator extends TweetTimelineV1Paginator<TweetV1TimelineResult, ListStatusesV1Params> {
protected _endpoint: string;
}
export declare class UserFavoritesV1Paginator extends TweetTimelineV1Paginator<TweetV1TimelineResult, TweetV1UserTimelineParams> {
protected _endpoint: string;
}
export {};