Class OnmsHTTPOptions

Hierarchy

OnmsHTTPOptions

Index

Constructors

constructor

Properties

Constructors

constructor

new OnmsHTTPOptions(timeout?: number, auth?: OnmsAuthConfig, server?: OnmsServer): OnmsHTTPOptions

- Defined in api/OnmsHTTPOptions.ts:23
Construct a new OnmsHTTPOptions object.

constructor

Parameters
- Optional timeout: number
- Optional auth: OnmsAuthConfig
- Optional server: OnmsServer
Returns OnmsHTTPOptions

Properties

auth

auth: OnmsAuthConfig

the authentication config that should be used when no server auth is configured

headers

headers: IHash<string> = {} as IHash<string>

http headers to be passed to the request

parameters

parameters: IHash<string> = {} as IHash<string>

http parameters to be passed on the URL

server

server: OnmsServer

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

timeout

timeout: number = 10000

how long to wait for ReST calls to time out

Generated using TypeDoc