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' });

Hierarchy

  • Rettiwt

Constructors

Properties

Constructors

  • Initializes a new Rettiwt instance using the given api key.

    Parameters

    • Optional config: IRettiwtConfig

      The config object for configuring the Rettiwt instance.

    Returns Rettiwt

Properties

The instance used to authenticate.

The instance used to fetch data related to tweets.

The instance used to fetch data related to users.

Generated using TypeDoc