Class FetcherService`Internal`

The base service that handles all HTTP requests.

Hierarchy

FetcherService

Index

Constructors

constructor

new FetcherService(config?): FetcherService
Parameters
- Optional config: IRettiwtConfig
  
  The config object for configuring the Rettiwt instance.
Returns FetcherService
- Defined in src/services/internal/FetcherService.ts:72

Properties

`Protected` `Optional` `Readonly` authProxyUrl

authProxyUrl?: URL

The URL to the proxy server to use for authentication.

`Private` `Optional` cred

cred?: AuthCredential

The credential to use for authenticating against Twitter API.

`Private` `Readonly` errorHandler

errorHandler: IErrorHandler

The service used to handle HTTP and API errors

`Private` `Readonly` httpsAgent

httpsAgent: Agent

The HTTPS Agent to use for requests to Twitter API.

`Private` `Readonly` isAuthenticated

isAuthenticated: boolean

Whether the instance is authenticated or not.

`Private` `Readonly` logger

logger: LogService

The log service instance to use to logging.

`Private` `Readonly` timeout

timeout: number

The max wait time for a response.

Methods

`Private` checkAuthorization

checkAuthorization(resourceType): void
Checks the authorization status based on the requested resource.
Parameters
- resourceType: EResourceType
  
  The type of resource to fetch.
Returns void

Throws
An error if not authorized to access the requested resource.
- Defined in src/services/internal/FetcherService.ts:122

`Private` deserializeData

deserializeData<OutType>(extractedData?, next?): CursoredData<OutType>
Deserializes the extracted data into a cursored list.
Type Parameters
- OutType extends User | Tweet
Parameters
- extractedData: (ITweet | IUser)[] = []
  
  The list of extracted data.
- next: string = ''
  
  The cursor to the next batch of data.
Returns CursoredData<OutType>
The cursored data object.
- Defined in src/services/internal/FetcherService.ts:241

`Private` extractData

extractData(data, type): {
next: string;
required: (ITweet | IUser)[];
}
Extracts the required data based on the type of resource passed as argument.
Parameters
- data: {}
  
  The data from which extraction is to be done.
- type: EResourceType
  
  The type of data to extract.
Returns {
next: string;
required: (ITweet | IUser)[];
}
The extracted data.
- next: string
  
  The cursor string to the next batch of data.
- required: (ITweet | IUser)[]
  
  The required extracted data.
- Defined in src/services/internal/FetcherService.ts:188

`Protected` fetch

fetch<OutType>(resourceType, args): Promise<CursoredData<OutType>>
Fetches the requested resource from Twitter and returns it after processing.
Type Parameters
- OutType extends User | Tweet
  
  The type of deserialized data returned.
Parameters
- resourceType: EResourceType
  
  The type of resource to fetch.
- args: FetchArgs
  
  Resource specific arguments.
Returns Promise<CursoredData<OutType>>
The processed data requested from Twitter.
- Defined in src/services/internal/FetcherService.ts:279

`Private` getAuthCredential

getAuthCredential(apiKey): AuthCredential
Returns an AuthCredential generated using the given API key.
Parameters
- apiKey: string
  
  The API key to use for authenticating.
Returns AuthCredential
The generated AuthCredential.
- Defined in src/services/internal/FetcherService.ts:99

`Private` getGuestCredential

getGuestCredential(guestKey): AuthCredential
Returns an AuthCredential generated using the given guest key.
Parameters
- guestKey: string
  
  The guest key to use for authenticating as guest.
Returns AuthCredential
The generated AuthCredential.
- Defined in src/services/internal/FetcherService.ts:112

`Private` getHttpsAgent

getHttpsAgent(proxyUrl?): Agent
Gets the HttpsAgent based on whether a proxy is used or not.
Parameters
- Optional proxyUrl: URL
  
  Optional URL with proxy configuration to use for requests to Twitter API.
Returns Agent
The HttpsAgent to use.
- Defined in src/services/internal/FetcherService.ts:143

`Protected` post

post(resourceType, args): Promise<boolean>
Posts the requested resource to Twitter and returns the response.
Parameters
- resourceType: EResourceType
  
  The type of resource to post.
- args: PostArgs
  
  Resource specific arguments.
Returns Promise<boolean>
Whether posting was successful or not.
- Defined in src/services/internal/FetcherService.ts:308

`Private` request

request<ResType>(config): Promise<AxiosResponse<ResType, any>>
Makes an HTTP request according to the given parameters.
Type Parameters
- ResType
  
  The type of the returned response data.
Parameters
- config: AxiosRequestConfig<any>
  
  The request configuration.
Returns Promise<AxiosResponse<ResType, any>>
The response received.
- Defined in src/services/internal/FetcherService.ts:158

`Protected` upload

upload(media): Promise<string>
Uploads the given media file to Twitter
Parameters
- media: string
  
  The path to the media file to upload.
Returns Promise<string>
The id of the uploaded media.
- Defined in src/services/internal/FetcherService.ts:327

Class FetcherServiceInternal

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional config: IRettiwtConfig

Returns FetcherService

Properties

Protected Optional Readonly authProxyUrl

Private Optional cred

Private Readonly errorHandler

Private Readonly httpsAgent

Private Readonly isAuthenticated

Private Readonly logger

Private Readonly timeout

Methods

Private checkAuthorization

Parameters

resourceType: EResourceType

Returns void

Throws

Private deserializeData

Type Parameters

OutType extends User | Tweet

Parameters

extractedData: (ITweet | IUser)[] = []

next: string = ''

Returns CursoredData<OutType>

Private extractData

Parameters

data: {}

type: EResourceType

Returns { next: string; required: (ITweet | IUser)[]; }

next: string

required: (ITweet | IUser)[]

Protected fetch

Type Parameters

OutType extends User | Tweet

Parameters

resourceType: EResourceType

args: FetchArgs

Returns Promise<CursoredData<OutType>>

Private getAuthCredential

Parameters

apiKey: string

Returns AuthCredential

Private getGuestCredential

Parameters

guestKey: string

Returns AuthCredential

Private getHttpsAgent

Parameters

Optional proxyUrl: URL

Returns Agent

Protected post

Parameters

resourceType: EResourceType

args: PostArgs

Returns Promise<boolean>

Private request

Type Parameters

ResType

Parameters

config: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<ResType, any>>

Protected upload

Parameters

media: string

Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

Class FetcherService`Internal`

`Optional` config: IRettiwtConfig

`Protected` `Optional` `Readonly` authProxyUrl

`Private` `Optional` cred

`Private` `Readonly` errorHandler

`Private` `Readonly` httpsAgent

`Private` `Readonly` isAuthenticated

`Private` `Readonly` logger

`Private` `Readonly` timeout

`Private` checkAuthorization

`Private` deserializeData

`Private` extractData

Returns {
next: string;
required: (ITweet | IUser)[];
}

`Protected` fetch

`Private` getAuthCredential

`Private` getGuestCredential

`Private` getHttpsAgent

`Optional` proxyUrl: URL

`Protected` post

`Private` request

`Protected` upload