Class User

The details of a single user.

Hierarchy

  • User

Constructors

constructor

Properties

createdAt description? followersCount followingsCount fullName id isVerified likeCount location? pinnedTweet? profileBanner? profileImage statusesCount userName

Methods

list single

Constructors

constructor

Properties

createdAt

createdAt: string

The creation date of user's account.

Optional description

description?: string

The user's description.

followersCount

followersCount: number

The number of followers of the user.

followingsCount

followingsCount: number

The number of following of the user.

fullName

fullName: string

The full name of the user.

id

id: string

The rest id of the user.

isVerified

isVerified: boolean

Whether the account is verified or not.

likeCount

likeCount: number

The number of tweets liked by the user.

Optional location

location?: string

The location of user as provided by user.

Optional pinnedTweet

pinnedTweet?: string

The rest id of the tweet pinned in the user's profile.

Optional profileBanner

profileBanner?: string

The url of the profile banner image.

profileImage

profileImage: string

The url of the profile image.

statusesCount

statusesCount: number

The number of tweets made by the user.

userName

userName: string

The username/screenname of the user.

Methods

Static list

  • Internal

    Extracts and deserializes the list of users from the given raw response data.

    Parameters

    • response: {}

      The raw response data.

      Returns User[]

      The deserialized list of users.

    Static single

    • Internal

      Extracts and deserializes a single target user from the given raw response data.

      Parameters

      • response: {}

        The raw response data.

        Returns undefined | User

        The target deserialized user.

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc