Interface IRettiwtConfig

The configuration for initializing a new Rettiwt instance.

Hierarchy

  • IRettiwtConfig

Properties

apiKey?: string

The apiKey (cookie) to use for authenticating Rettiwt against Twitter API.

authProxyUrl?: URL

Optional URL to proxy server to use for authentication against Twitter API.

Remarks

Required when deploying to cloud platforms to bypass Error 429.

Default Value

Same as proxyUrl

errorHandler?: IErrorHandler

Optional custom error handler to define error conditions and process API/HTTP errors in responses.

guestKey?: string

The guestKey (guest token) to use for guest access to Twitter API.

logging?: boolean

Whether to write logs to console or not.

proxyUrl?: URL

Optional URL to proxy server to use for requests to Twitter API.

Remarks

When deploying to cloud platforms, if setting authProxyUrl does not resolve Error 429, then this might be required.

timeout?: number

The max wait time (in milli-seconds) for a response; if not set, Twitter server timeout is used.

Generated using TypeDoc