Class TwitarrHTTPOptions

Options to be used when making HTTP ReST calls.

Hierarchy

TwitarrHTTPOptions

Index

Constructors

constructor

Properties

Accessors

auth
timeout

Methods

Constructors

constructor

new TwitarrHTTPOptions(timeout?: number, auth?: TwitarrAuthConfig, server?: TwitarrServer): TwitarrHTTPOptions

- Defined in api/TwitarrHTTPOptions.ts:57
Construct a new TwitarrHTTPOptions object.

constructor

Parameters
- Optional timeout: number
- Optional auth: TwitarrAuthConfig
- Optional server: TwitarrServer
Returns TwitarrHTTPOptions

Properties

Private __computed

__computed: TwitarrAuthConfig

data

data: any

HTTP data to be passed when POSTing

headers

headers: IHash<string>

HTTP headers to be passed to the request.

parameters

parameters: IHash<string>

HTTP parameters to be passed on the URL.

server

server: TwitarrServer

The server to use if no server is set on the HTTP implementation.

Accessors

auth

get auth(): TwitarrAuthConfig
set auth(a: TwitarrAuthConfig): void

- Defined in api/TwitarrHTTPOptions.ts:32
The authentication config that should be used when no auth is associated with the TwitarrServer.

Returns TwitarrAuthConfig
- Defined in api/TwitarrHTTPOptions.ts:39
The authentication config that should be used when no auth is associated with the TwitarrServer.

Parameters
- a: TwitarrAuthConfig
Returns void

timeout

get timeout(): number
set timeout(t: number): void

- Defined in api/TwitarrHTTPOptions.ts:20
How long to wait for ReST calls to time out.

Returns number
- Defined in api/TwitarrHTTPOptions.ts:27
How long to wait for ReST calls to time out.

Parameters
- t: number
Returns void

Methods

toJSON

toJSON(): object

- Defined in api/TwitarrHTTPOptions.ts:107
Returns object

withData

withData(data: any): TwitarrHTTPOptions

- Defined in api/TwitarrHTTPOptions.ts:101
Set the data to be passed when POSTing.

Parameters
- data: any
  
  the data to POST
Returns TwitarrHTTPOptions

withHeader

withHeader(header: string, value: string): TwitarrHTTPOptions

- Defined in api/TwitarrHTTPOptions.ts:80
Add a header. Returns the TwitarrHTTPOptions object so it can be chained.

Parameters
- header: string
- value: string
  
  the header value
Returns TwitarrHTTPOptions

withParameter

withParameter(key: string, value?: any): TwitarrHTTPOptions

- Defined in api/TwitarrHTTPOptions.ts:90
Add a URL parameter. Returns the TwitarrHTTPOptions object so it can be chained.

Parameters
- key: string
  
  the parameter's key
- Optional value: any
  
  the parameter's value
Returns TwitarrHTTPOptions

Generated using TypeDoc