Interface ITweetFilter

The filter to be used for searching tweets.

interface ITweetFilter {
    endDate?: Date;
    excludeWords?: string[];
    fromUsers?: string[];
    hashtags?: string[];
    includePhrase?: string;
    includeWords?: string[];
    language?: string;
    links?: boolean;
    list?: string;
    maxId?: string;
    mentions?: string[];
    minLikes?: number;
    minReplies?: number;
    minRetweets?: number;
    optionalWords?: string[];
    quoted?: string;
    replies?: boolean;
    sinceId?: string;
    startDate?: Date;
    top?: boolean;
    toUsers?: string[];
}

Implemented by

Properties

endDate? excludeWords? fromUsers? hashtags? includePhrase? includeWords? language? links? list? maxId? mentions? minLikes? minReplies? minRetweets? optionalWords? quoted? replies? sinceId? startDate? top? toUsers?

Properties

OptionalendDate

endDate?: Date

The date upto which tweets are to be searched.

OptionalexcludeWords

excludeWords?: string[]

The list of words to exclude from search.

OptionalfromUsers

fromUsers?: string[]

The list of usernames whose tweets are to be searched.

Remarks

'@' must be excluded from the username!

Optionalhashtags

hashtags?: string[]

The list of hashtags to search.

Remarks

'#' must be excluded from the hashtag!

OptionalincludePhrase

includePhrase?: string

The exact phrase to search.

OptionalincludeWords

includeWords?: string[]

The list of words to search.

Optionallanguage

language?: string

The language of the tweets to search.

Optionallinks

links?: boolean

Whether to fetch tweets that are links or not.

Optionallist

list?: string

The list from which tweets are to be searched.

OptionalmaxId

maxId?: string

The id of the tweet, before which the tweets are to be searched.

Optionalmentions

mentions?: string[]

The list of username mentioned in the tweets to search.

Remarks

'@' must be excluded from the username!

OptionalminLikes

minLikes?: number

The minimun number of likes to search by.

OptionalminReplies

minReplies?: number

The minimum number of replies to search by.

OptionalminRetweets

minRetweets?: number

The minimum number of retweets to search by.

OptionaloptionalWords

optionalWords?: string[]

The optional words to search.

Optionalquoted

quoted?: string

The id of the tweet which is quoted in the tweets to search.

Optionalreplies

replies?: boolean

Whether to fetch tweets that are replies or not.

OptionalsinceId

sinceId?: string

The id of the tweet, after which the tweets are to be searched.

OptionalstartDate

startDate?: Date

The date starting from which tweets are to be searched.

Optionaltop

top?: boolean

Whether to fetch top tweets or not.

OptionaltoUsers

toUsers?: string[]

The list of username to whom the tweets to be searched, are adressed.

Remarks

'@' must be excluded from the username!

Settings

Member Visibility

On This Page

Properties