Class SuperAgentHTTP

Hierarchy

AbstractHTTP
- SuperAgentHTTP

Implements

IOnmsHTTP

Index

Constructors

constructor

Properties

Accessors

server

Methods

Constructors

constructor

new SuperAgentHTTP(server?: OnmsServer, saImpl?: any, timeout?: number): SuperAgentHTTP

Overrides AbstractHTTP.constructor
- Defined in rest/SuperAgentHTTP.ts:26
Parameters
- Optional server: OnmsServer
- Optional saImpl: any
- Default value timeout: number = 10000
Returns SuperAgentHTTP

Properties

options

options: OnmsHTTPOptions

the authorization config associated with this ReST client

Private saImpl

saImpl: any

the SuperAgent implementation, override if using nodejs instead of the browser

timeout

timeout: number = 10000

how long to wait before giving up on a given request

Accessors

server

get server(): OnmsServer
set server(server: OnmsServer): void

Inherited from AbstractHTTP.server
- Defined in rest/AbstractHTTP.ts:34
the server associated with this HTTP implementation

Returns OnmsServer
Inherited from AbstractHTTP.server
- Defined in rest/AbstractHTTP.ts:38
the server associated with this HTTP implementation

Parameters
- server: OnmsServer
Returns void

Methods

get

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

Implementation of IOnmsHTTP.get

Overrides AbstractHTTP.get
- Defined in rest/SuperAgentHTTP.ts:34
make an HTTP get call -- this should be overridden by the implementation

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

Private getImpl

getImpl(method: string, url: string, options?: OnmsHTTPOptions): any

- Defined in rest/SuperAgentHTTP.ts:45
internal method for getting/constructing a superAgent object on-demand, based on the current server config

Parameters
- method: string
- url: string
- Optional options: OnmsHTTPOptions
Returns any

Protected getOptions

getOptions(options?: OnmsHTTPOptions): any

Inherited from AbstractHTTP.getOptions
- Defined in rest/AbstractHTTP.ts:83
combine all options from the given options, the current server, and the default options

Parameters
- Optional options: OnmsHTTPOptions
Returns any

Protected getServer

getServer(options?: OnmsHTTPOptions): OnmsServer

Inherited from AbstractHTTP.getServer
- Defined in rest/AbstractHTTP.ts:78
get the server in the options object, or fall back to the one assigned to the HTTP impl

Parameters
- Optional options: OnmsHTTPOptions
Returns OnmsServer

Protected onSetServer

onSetServer(): void

Inherited from AbstractHTTP.onSetServer
- Defined in rest/AbstractHTTP.ts:97
useful for performing an action (like clearing caches) when the server is set

Returns void

Protected transformJSON

transformJSON(data: any): any

Inherited from AbstractHTTP.transformJSON
- Defined in rest/AbstractHTTP.ts:58
a convenience method for implementers to use to turn JSON into a javascript object

Parameters
- data: any
Returns any

Protected transformXML

transformXML(data: any): any

Inherited from AbstractHTTP.transformXML
- Defined in rest/AbstractHTTP.ts:68
a convenience method for implementers to use to turn XML into a javascript object

Parameters
- data: any
Returns any

Generated using TypeDoc