Class Twitter

Classdesc

Twitter Class, which handles all relevant statistical endpoints from the Twitter API

Param

Twittter Developer Token

Hierarchy

Twitter

Index

Constructors

Properties

Methods

UserLookupByName req

Constructors

constructor

new Twitter(options: TwitterOptions): Twitter
Parameters
- options: TwitterOptions
Returns Twitter
- Defined in classes/twitter.ts:14

Properties

token

token: string

Methods

UserLookupByName

UserLookupByName(user: string): Promise<any>
It takes a Twitter username as a parameter, and returns a JSON object containing the user's information.

Async

Returns
The user's information.
Parameters
- user: string
  
  The username of the user you want to look up.
Returns Promise<any>
- Defined in classes/twitter.ts:47

`Private` req

req(url: string): Promise<any>
Private
It makes a request to the url, and if the response is ok, it returns the body data, otherwise it throws an error.

Async

Returns
The data from the API.
Parameters
- url: string
  
  The url you want to send the request to.
Returns Promise<any>
- Defined in classes/twitter.ts:25

Generated using TypeDoc