Class TwitterUsers

Represents a class for interacting with Twitter users.

Hierarchy (view full)

Constructors

constructor

Properties

client

Methods

avatar banner get getApiKeys makeRequest

Constructors

constructor

Properties

client

client: Client

The client used to make requests.

Methods

avatar

  • avatar(username?): Promise<any>

  • Retrieves the avatar of a Twitter user.

    Parameters

    • Optional username: string = "mdc_dev"

      The username of the Twitter user. Defaults to "@mdc_dev" which represents the authenticated user.

    Returns Promise<any>

    • A promise that resolves with the avatar image data.

banner

  • banner(username?): Promise<any>

  • Retrieves the banner image of a Twitter user.

    Parameters

    • Optional username: string = "mdc_dev"

      The username of the Twitter user. Defaults to "@mdc_dev" which represents the authenticated user.

    Returns Promise<any>

    • A promise that resolves with the banner image data.

get

  • get(username?): Promise<any>

  • Retrieves information about a Twitter user.

    Parameters

    • Optional username: string = "mdc_dev"

      The username of the Twitter user. Defaults to "@mdc_dev" which represents the authenticated user.

    Returns Promise<any>

    • A promise that resolves with the user information.

getApiKeys

makeRequest

  • makeRequest(endpoint, data?): Promise<any>

  • Makes an HTTP request to the specified endpoint.

    Parameters

    • endpoint: string

      The endpoint to make the request to.

    • Optional data: any

      The data to send with the request (optional).

    Returns Promise<any>

    A Promise that resolves to the response data.

    Throws

    If the request fails.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc