Interface Options

interface Options {
    baseUrl?: string;
    consumer_key?: string;
    consumer_secret?: string;
    returnPromises?: boolean;
    token?: string;
    token_secret?: string;
}

Properties

baseUrl? consumer_key? consumer_secret? returnPromises? token? token_secret?

Properties

OptionalbaseUrl

baseUrl?: string

(optional) The API url if different from the default.

Optionalconsumer_key

consumer_key?: string

OAuth1 credential. Required for API key auth endpoints.

Optionalconsumer_secret

consumer_secret?: string

OAuth1 credential. Required for OAuth endpoints.

OptionalreturnPromises

returnPromises?: boolean

Deprecated

Methods will return promises if no callback is provided.

Optionaltoken

token?: string

OAuth1 credential. Required for OAuth endpoints.

Optionaltoken_secret

token_secret?: string

OAuth1 credential. Required for Oauth endpoints.

Settings

Member Visibility

On This Page

Properties