Interface TwitterAuth

fetch

authenticatedAt

• authenticatedAt(): null | Date

• Returns the time that authentication was performed.

  Returns null | Date

  The time at which the authentication token was created, or null if it hasn't been created yet.

cookieJar

• cookieJar(): CookieJar

• Returns the current cookie jar.

  Returns CookieJar

deleteToken

• deleteToken(): void

• Deletes the current guest token token.

  Returns void

hasToken

• hasToken(): boolean

• Returns if the authentication state has a token.

  Returns boolean

  true if the authentication state has a token; false otherwise.

installTo

• installTo(headers, url): Promise<void>

• Installs the authentication information into a headers-like object. If needed, the authentication token will be updated from the API automatically.

  Parameters

  • headers: Headers$1

    A Headers instance representing a request's headers.

  • url: string

  Returns Promise<void>

isLoggedIn

• isLoggedIn(): Promise<boolean>

• Returns if a user is logged-in to Twitter through this instance.

  Returns Promise<boolean>

  true if a user is logged-in; otherwise false.

login

• login(username, password, email?, twoFactorSecret?): Promise<void>

• Logs into a Twitter account.

  Parameters

  • username: string

    The username to log in with.

  • password: string

    The password to log in with.

  • Optional email: string

    The email to log in with, if you have email confirmation enabled.

  • Optional twoFactorSecret: string

    The secret to generate two factor authentication tokens with, if you have two factor authentication enabled.

  Returns Promise<void>

logout

• logout(): Promise<void>

• Logs out of the current session.

  Returns Promise<void>