Class TwitterGuestAuth

A guest authentication token manager. Automatically handles token refreshes.

Hierarchy

TwitterGuestAuth
- TwitterUserAuth

Implements

TwitterAuth

Index

Constructors

Properties

bearerToken fetch guestCreatedAt? guestToken? jar options?

Methods

authenticatedAt cookieJar deleteToken getCookieJarUrl getCookieString getCookies hasToken installTo isLoggedIn login logout removeCookie shouldUpdate updateGuestToken

Constructors

constructor

new TwitterGuestAuth(bearerToken, options?): TwitterGuestAuth
Parameters
- bearerToken: string
- Optional options: Partial<TwitterAuthOptions>
Returns TwitterGuestAuth
- Defined in src/auth.ts:101

Properties

`Protected` bearerToken

bearerToken: string

fetch

fetch: {
(input, init?): Promise<Response>;
(input, init?): Promise<Response>;
}

Type declaration

- (input, init?): Promise<Response>
- MDN Reference
  Parameters
  - input: RequestInfo | URL
  - Optional init: RequestInit
  Returns Promise<Response>
- (input, init?): Promise<Response>
- Parameters
  - input: string | Request | URL
  - Optional init: RequestInit
  Returns Promise<Response>

`Protected` `Optional` guestCreatedAt

guestCreatedAt?: Date

`Protected` `Optional` guestToken

guestToken?: string

`Protected` jar

jar: CookieJar

`Protected` `Optional` `Readonly` options

options?: Partial<TwitterAuthOptions>

Methods

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.
Implementation of TwitterAuth.authenticatedAt
- Defined in src/auth.ts:138

cookieJar

cookieJar(): CookieJar
Returns the current cookie jar.

Returns CookieJar
Implementation of TwitterAuth.cookieJar
- Defined in src/auth.ts:110

deleteToken

deleteToken(): void
Deletes the current guest token token.

Returns void
Implementation of TwitterAuth.deleteToken
- Defined in src/auth.ts:129

`Private` getCookieJarUrl

getCookieJarUrl(): string
Returns string
- Defined in src/auth.ts:190

`Protected` getCookieString

getCookieString(): Promise<string>
Returns Promise<string>
- Defined in src/auth.ts:172

`Protected` getCookies

getCookies(): Promise<Cookie[]>
Returns Promise<Cookie[]>
- Defined in src/auth.ts:168

hasToken

hasToken(): boolean
Returns if the authentication state has a token.

Returns boolean
true if the authentication state has a token; false otherwise.
Implementation of TwitterAuth.hasToken
- Defined in src/auth.ts:134

installTo

installTo(headers): 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.
Returns Promise<void>
Implementation of TwitterAuth.installTo
- Defined in src/auth.ts:146

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.
Implementation of TwitterAuth.isLoggedIn
- Defined in src/auth.ts:114

login

login(_username, _password, _email?): 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.
Returns Promise<void>
Implementation of TwitterAuth.login
- Defined in src/auth.ts:119

logout

logout(): Promise<void>
Logs out of the current session.

Returns Promise<void>
Implementation of TwitterAuth.logout
- Defined in src/auth.ts:123

`Protected` removeCookie

removeCookie(key): Promise<void>
Parameters
- key: string
Returns Promise<void>
- Defined in src/auth.ts:176

`Private` shouldUpdate

shouldUpdate(): boolean
Returns if the authentication token needs to be updated or not.

Returns boolean
true if the token needs to be updated; false otherwise.
- Defined in src/auth.ts:237

`Protected` updateGuestToken

updateGuestToken(): Promise<void>
Updates the authentication state with a new guest token from the Twitter API.

Returns Promise<void>
- Defined in src/auth.ts:199