Class AbstractHTTP

Abstract implementation of the TwitarrHTTP interface meant to be extended by a concrete class.

implements: ITwitarrHTTP

Hierarchy

AbstractHTTP
- BrowserHTTP

Implements

ITwitarrHTTP

Index

Constructors

constructor

Properties

__computed

Accessors

Methods

Constructors

constructor

new AbstractHTTP(server?: TwitarrServer, timeout?: number): AbstractHTTP

- Defined in rest/AbstractHTTP.ts:50
Create a new HTTP instance.

constructor

Parameters
- Optional server: TwitarrServer
  
  A server object for immediate configuration.
- Optional timeout: number
  
  How long to wait until timing out requests.
Returns AbstractHTTP

Properties

Private __computed

__computed: TwitarrHTTPOptions = new TwitarrHTTPOptions()

Accessors

options

get options(): TwitarrHTTPOptions
set options(o: TwitarrHTTPOptions): void

- Defined in rest/AbstractHTTP.ts:25
The default set of HTTP options associated with this ReST client.

Returns TwitarrHTTPOptions
- Defined in rest/AbstractHTTP.ts:32
The default set of HTTP options associated with this ReST client.

Parameters
- o: TwitarrHTTPOptions
Returns void

server

get server(): TwitarrServer
set server(server: TwitarrServer): void

- Defined in rest/AbstractHTTP.ts:43
The server associated with this HTTP implementation.

Returns TwitarrServer
- Defined in rest/AbstractHTTP.ts:47
The server associated with this HTTP implementation.

Parameters
- server: TwitarrServer
Returns void

Methods

Abstract get

get(url: string, options?: TwitarrHTTPOptions): Promise<TwitarrResult<any>>

Implementation of ITwitarrHTTP.get
- Defined in rest/AbstractHTTP.ts:107
Make an HTTP GET call. This must be implemented by the concrete implementation.

Parameters
- url: string
- Optional options: TwitarrHTTPOptions
Returns Promise<TwitarrResult<any>>

Protected getData

getData(response: any): any

- Defined in rest/AbstractHTTP.ts:130
Attempt to extract the data from a response.

Parameters
- response: any
Returns any

getKey

getKey(): string

Implementation of ITwitarrHTTP.getKey
- Defined in rest/AbstractHTTP.ts:93
Returns string

Protected getOptions

getOptions(options?: TwitarrHTTPOptions): TwitarrHTTPOptions

- Defined in rest/AbstractHTTP.ts:173
Get the union of TwitarrHTTPOptions based on the passed options, defaults, and options in the TwitarrServer associated with this request. Order of precedence is passed options -> server options -> default options.

Parameters
- Optional options: TwitarrHTTPOptions
Returns TwitarrHTTPOptions

getPassword

getPassword(): string

Implementation of ITwitarrHTTP.getPassword
- Defined in rest/AbstractHTTP.ts:80
Returns string

Protected getServer

getServer(options?: TwitarrHTTPOptions): TwitarrServer

- Defined in rest/AbstractHTTP.ts:161
Get the TwitarrServer object that should be used for making requests. Favors the one passed in the TwitarrHTTPOptions, otherwise it falls back to the default server associated with the HTTP implementation.

Parameters
- Optional options: TwitarrHTTPOptions
Returns TwitarrServer

getUsername

getUsername(): string

Implementation of ITwitarrHTTP.getUsername
- Defined in rest/AbstractHTTP.ts:67
Returns string

Abstract httpDelete

httpDelete(url: string, options?: TwitarrHTTPOptions): Promise<TwitarrResult<any>>

Implementation of ITwitarrHTTP.httpDelete
- Defined in rest/AbstractHTTP.ts:116
Make an HTTP DELETE call. This must be overridden by the concrete implementation.

Parameters
- url: string
- Optional options: TwitarrHTTPOptions
Returns Promise<TwitarrResult<any>>

Protected onSetServer

onSetServer(): void

- Defined in rest/AbstractHTTP.ts:193
Implementers should override this method if they have actions that need to be performed (like clearing a cache) when server settings change.

Returns void

Abstract post

post(url: string, options?: TwitarrHTTPOptions): Promise<TwitarrResult<any>>

Implementation of ITwitarrHTTP.post
- Defined in rest/AbstractHTTP.ts:113
Make an HTTP POST call. This must be overridden by the concrete implementation.

Parameters
- url: string
- Optional options: TwitarrHTTPOptions
Returns Promise<TwitarrResult<any>>

Abstract postFile

postFile(url: string, fileName: string, contentType: string, data: Buffer, options?: TwitarrHTTPOptions): Promise<TwitarrResult<any>>

Implementation of ITwitarrHTTP.postFile
- Defined in rest/AbstractHTTP.ts:119
POST a file. This must be overridden by the concrete implementation.

Parameters
- url: string
- fileName: string
- contentType: string
- data: Buffer
- Optional options: TwitarrHTTPOptions
Returns Promise<TwitarrResult<any>>

Abstract put

put(url: string, options?: TwitarrHTTPOptions): Promise<TwitarrResult<any>>

Implementation of ITwitarrHTTP.put
- Defined in rest/AbstractHTTP.ts:110
Make an HTTP PUT call. This must be overridden by the concrete implementation.

Parameters
- url: string
- Optional options: TwitarrHTTPOptions
Returns Promise<TwitarrResult<any>>

setKey

setKey(key: string): ITwitarrHTTP

Implementation of ITwitarrHTTP.setKey
- Defined in rest/AbstractHTTP.ts:97
Parameters
- key: string
Returns ITwitarrHTTP

setPassword

setPassword(password: string): this

Implementation of ITwitarrHTTP.setPassword
- Defined in rest/AbstractHTTP.ts:84
Parameters
- password: string
Returns this

setUsername

setUsername(username: string): this

Implementation of ITwitarrHTTP.setUsername
- Defined in rest/AbstractHTTP.ts:71
Parameters
- username: string
Returns this

Protected transformJSON

transformJSON(data: any): any

- Defined in rest/AbstractHTTP.ts:125
A convenience method for implementers to use to turn JSON into a javascript object. Use this to process a JSON response before returning it in an TwitarrResult object.

Parameters
- data: any
Returns any

Generated using TypeDoc