@virtuals-protocol/game-twitter-node
Version:
Strongly typed, full-featured, light, versatile yet powerful Virtual Twitter API v2 client for Node.js. Forked from twitter-api-v2.
65 lines (64 loc) • 1.99 kB
TypeScript
/// <reference types="node" />
import type { Agent } from "http";
import type { ITwitterApiClientPlugin } from "./plugins";
import type { TRequestCompressionLevel } from "./request-maker.mixin.types";
export declare enum ETwitterStreamEvent {
Connected = "connected",
ConnectError = "connect error",
ConnectionError = "connection error",
ConnectionClosed = "connection closed",
ConnectionLost = "connection lost",
ReconnectAttempt = "reconnect attempt",
Reconnected = "reconnected",
ReconnectError = "reconnect error",
ReconnectLimitExceeded = "reconnect limit exceeded",
DataKeepAlive = "data keep-alive",
Data = "data event content",
DataError = "data twitter error",
TweetParseError = "data tweet parse error",
Error = "stream error"
}
export interface TwitterApiTokens {
appKey?: string;
appSecret?: string;
accessToken?: string;
accessSecret?: string;
gameTwitterAccessToken?: string;
}
export interface TwitterApiOAuth2Init {
clientId: string;
clientSecret?: string;
}
export interface TwitterApiBasicAuth {
username: string;
password: string;
}
export interface IClientTokenBearer {
bearerToken: string;
type: "oauth2";
}
export interface IClientOAuth2UserClient {
clientId: string;
type: "oauth2-user";
}
export interface IClientTokenBasic {
token: string;
type: "basic";
}
export interface IClientTokenOauth {
appKey: string;
appSecret: string;
accessToken?: string;
accessSecret?: string;
type: "oauth-1.0a";
}
export interface IClientTokenNone {
type: "none";
}
export type TClientTokens = IClientTokenNone | IClientTokenBearer | IClientTokenOauth | IClientTokenBasic | IClientOAuth2UserClient;
export interface IClientSettings {
/** Used to send HTTPS requests. This is mostly used to make requests work behind a proxy. */
httpAgent: Agent;
plugins: ITwitterApiClientPlugin[];
compression: TRequestCompressionLevel;
}