Interface ITwitarrHTTP

Interface for making ReST calls to an HTTP server.

interface

Hierarchy

ITwitarrHTTP

Implemented by

Index

Properties

Methods

Properties

options

options: TwitarrHTTPOptions

The default options used when making requests with this instance.

server

server: TwitarrServer

The server associated with this instance.

Methods

get

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

- Defined in api/ITwitarrHTTP.ts:49
Perform an HTTP GET to the provided URL.

Parameters
- url: string
  
  The URL to connect to.
- Optional options: TwitarrHTTPOptions
  
  The TwitarrHTTPOptions options to use when connecting.
Returns Promise<TwitarrResult<any>>

A TwitarrResult result object.

getKey

getKey(): string

- Defined in api/ITwitarrHTTP.ts:40
The authorization key to use for ReST APIv2 calls.

Returns string

getPassword

getPassword(): string

- Defined in api/ITwitarrHTTP.ts:36
The password for ReST APIv2 calls.

Returns string

getUsername

getUsername(): string

- Defined in api/ITwitarrHTTP.ts:32
The username for ReST APIv2 calls.

Returns string

httpDelete

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

- Defined in api/ITwitarrHTTP.ts:73
Perform an HTTP DELETE to the provided URL.

Parameters
- url: string
  
  The URL to connect to.
- Optional options: TwitarrHTTPOptions
  
  The TwitarrHTTPOptions options to use when connecting.
Returns Promise<TwitarrResult<any>>

A TwitarrResult result object.

post

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

- Defined in api/ITwitarrHTTP.ts:65
Perform an HTTP POST to the provided URL.

Parameters
- url: string
  
  The URL to connect to.
- Optional options: TwitarrHTTPOptions
  
  The TwitarrHTTPOptions options to use when connecting.
Returns Promise<TwitarrResult<any>>

A TwitarrResult result object.

postFile

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

- Defined in api/ITwitarrHTTP.ts:85
Post a file to the provided URL using a multipart/form-data request.

Parameters
- url: string
  
  The URL to connect to.
- fileName: string
  
  The name of the file to be uploaded.
- contentType: string
  
  The content-type of the file to be uploaded.
- data: Buffer
  
  The file (as bytes) to send.
- Optional options: TwitarrHTTPOptions
  
  The TwitarrHTTPOptions options to use when connecting.
Returns Promise<TwitarrResult<any>>

A TwitarrResult result object.

put

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

- Defined in api/ITwitarrHTTP.ts:57
Perform an HTTP PUT to the provided URL.

Parameters
- url: string
  
  The URL to connect to.
- Optional options: TwitarrHTTPOptions
  
  The TwitarrHTTPOptions options to use when connecting.
Returns Promise<TwitarrResult<any>>

A TwitarrResult result object.

setKey

setKey(key: string): ITwitarrHTTP

- Defined in api/ITwitarrHTTP.ts:41
Parameters
- key: string
Returns ITwitarrHTTP

setPassword

setPassword(password: string): ITwitarrHTTP

- Defined in api/ITwitarrHTTP.ts:37
Parameters
- password: string
Returns ITwitarrHTTP

setUsername

setUsername(username: string): ITwitarrHTTP

- Defined in api/ITwitarrHTTP.ts:33
Parameters
- username: string
Returns ITwitarrHTTP

Generated using TypeDoc