Class FetchArgs

Options specifying the data that is to be fetched.

Hierarchy

FetchArgs

Index

Constructors

Properties

count? cursor? filter? id?

Constructors

constructor

new FetchArgs(resource, args): FetchArgs
Parameters
- resource: EResourceType
  
  The resource to be fetched.
- args: FetchArgs
  
  Additional user-defined arguments for fetching the resource.
Returns FetchArgs
- Defined in src/models/args/FetchArgs.ts:133

Properties

`Optional` count

count?: number

The number of data items to fetch.

Remarks

Works only for cursored resources.
Must be <= 20 for:
Must be <= 100 for all other cursored resources.
Due a bug on Twitter's end, count does not work for USER_FOLLOWERS and USER_FOLLOWING.
Has not effect for:
- USER_FEED_FOLLOWED
- USER_FEED_RECOMMENDED

Default Value

20

`Optional` cursor

cursor?: string

The cursor to the batch of data to fetch.

Remarks

May be used for cursored resources.
Has no effect for other resources.

`Optional` filter

filter?: TweetFilter

The filter for searching tweets.

Remarks

Required when searching for tweets using TWEET_SEARCH.

`Optional` id

id?: string

The id of the target resource.

Remarks

Required for all resources except TWEET_SEARCH and EResourceType.USER_TIMELINE_RECOMMENDED.
For USER_DETAILS_BY_USERNAME, can be alphanumeric, while for others, is strictly numeric.

Generated using TypeDoc