Class TweetFilter

The filter to be used for fetching tweets from Twitter.

Hierarchy

  • TweetFilter

Constructors

  • Parameters

    • filter: TweetFilter

      The filter to use for searching tweets.

    Returns TweetFilter

Properties

endDate?: Date

The date upto which tweets are to be searched.

excludeWords?: string[]

The list of words to exclude from search.

fromUsers?: string[]

The list of usernames whose tweets are to be searched.

Remarks

'@' must be excluded from the username!

hashtags?: string[]

The list of hashtags to search.

Remarks

'#' must be excluded from the hashtag!

includePhrase?: string

The exact phrase to search.

includeWords?: string[]

The list of words to search.

language?: string

The language of the tweets to search.

links?: boolean

Whether to fetch tweets that are links or not.

Default Value

true

maxId?: string

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

mentions?: string[]

The list of username mentioned in the tweets to search.

Remarks

'@' must be excluded from the username!

minLikes?: number

The minimun number of likes to search by.

minReplies?: number

The minimum number of replies to search by.

minRetweets?: number

The minimum number of retweets to search by.

optionalWords?: string[]

The optional words to search.

quoted?: string

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

replies?: boolean

Whether to fetch tweets that are replies or not.

Default Value

true

sinceId?: string

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

startDate?: Date

The date starting from which tweets are to be searched.

toUsers?: string[]

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

Remarks

'@' must be excluded from the username!

dateToTwitterString: any

Convert Date object to Twitter string representation. eg - 2023-06-23_11:21:06_UTC

Param

The date object to convert.

Returns

The Twitter string representation of the date.

Methods

  • Internal

    Returns string

    The string representation of 'this' object.

Generated using TypeDoc