JSDoc: Class: TwitterRSSFeed

Constructor

new TwitterRSSFeed(credentials)

Creates a instance of TwitterRSSFeed.

Parameters:

Name	Type	Description
`credentials`	Credentials	Twitter credentials

Source:

index.js, line 32

Methods

(static) public_users_filter() → {function}

Returns a filter function that extracts only the public user's tweets.

Source:

index.js, line 178

Returns:

A filter function that extracts only the public user's tweets

Type: function

(static) standard_formatter() → {function}

Returns a standard formatter function.

Source:

index.js, line 140

Returns:

A standard formatter function

Type: function

(async) favorites_list(params, info, opts) → {Promise.<string>}

Returns a RSS feed of Twitter API (GET favorites/list).

Parameters:

Name	Type	Description
`params`	Object	Parameters of Twitter API (GET favorites/list).
`info`	Object	A RSS information.
`opts`	Options	Options.

Source:

index.js, line 73

See:

GET favorites/list — Twitter Developers

Returns:

A RSS feed.

Type: Promise.<string>

(async) get(path, params) → {Promise.<Object>}

Returns a response object of Twitter API.

Parameters:

Name	Type	Description
`path`	string	Path of Twitter API (Ex. 'statuses/user_timeline').
`params`	Object	Parameters of Twitter API.

Source:

index.js, line 48

See:

API reference index — Twitter Developers

Returns:

A response object of Twitter API.

Type: Promise.<Object>

rss(tweets, info, opts) → {string}

Returns a RSS feed of Tweet objects.

Parameters:

Name	Type	Description
`tweets`	Array.<Object>	An array of Tweet object.
`info`	Object	A RSS information.
`opts`	Options	Options.

Source:

index.js, line 100

See:

Tweet object — Twitter Developers

Returns:

A RSS feed.

Type: string

(async) search_tweets(params, info, opts) → {Promise.<string>}

Returns a RSS feed of Twitter API (Standard search API).

Parameters:

Name	Type	Description
`params`	Object	Parameters of Twitter API (Standard search API).
`info`	Object	A RSS information.
`opts`	Options	Options.

Source:

index.js, line 86

See:

Standard search API — Twitter Developers

Returns:

A RSS feed.

Type: Promise.<string>

(async) statuses_user_timeline(params, info, opts) → {Promise.<string>}

Returns a RSS feed of Twitter API (GET statuses/user_timeline).

Parameters:

Name	Type	Description
`params`	Object	Parameters of Twitter API (GET statuses/user_timeline).
`info`	Object	A RSS information.
`opts`	Options	Options.

Source:

index.js, line 60

See:

GET statuses/user_timeline — Twitter Developers

Returns:

A RSS feed.

Type: Promise.<string>