Class Rettiwt

The class for accessing Twitter API.

The created Rettiwt instance can be configured by passing in a configuration object to the constructor.

For details regarding the available configuration options, refer to IRettiwtConfig

Example: Creating a Rettiwt instance with 'guest' authentication:

import { Rettiwt } from 'rettiwt-api';

// Creating a new Rettiwt instance
const rettiwt = new Rettiwt();

Example: Creating a Rettiwt instance with 'guest' authentication, using a pre-generated guest key:

import { Rettiwt } from 'rettiwt-api';

// Creating a new Rettiwt instance
const rettiwt = new Rettiwt({ guestKey: 'GUEST_KEY' });

Example: Creating a Rettiwt instance with 'user' authentication:

import { Rettiwt } from 'rettiwt-api';

// Creating a new Rettiwt instance
const rettiwt = new Rettiwt({ apiKey: 'API_KEY' });

Example: Creating a Rettiwt instance with 'user'authentication, along with enabling debug logs and using a proxy:

import { Rettiwt } from 'rettiwt-api';

// Creating a new Rettiwt instance
const rettiwt = new Rettiwt({ apiKey: 'API_KEY', logging: true, proxyUrl: 'URL_TO_PROXY_SERVER' });

Constructors

constructor

Properties

list tweet user

Accessors

apiKey headers proxyUrl

Constructors

constructor

Properties

list

list: ListService

The instance used to fetch data related to lists.

tweet

tweet: TweetService

The instance used to fetch data related to tweets.

user

user: UserService

The instance used to fetch data related to users.

Accessors

apiKey

  • set apiKey(apiKey: undefined | string): void

    Set the API key for the current instance.

    Parameters

    • apiKey: undefined | string

    Returns void

headers

  • set headers(headers: { [key: string]: string }): void

    Set the custom headers for the current instance.

    Parameters

    • headers: { [key: string]: string }

    Returns void

proxyUrl

  • set proxyUrl(proxyUrl: URL): void

    Set the proxy URL for the current instance.

    Parameters

    • proxyUrl: URL

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors