Class OnmsHTTPOptions

Hierarchy

OnmsHTTPOptions

Index

Constructors

constructor

Properties

Constructors

constructor

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

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

constructor

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

Properties

accept

accept: string = "application/xml"

the type of response to accept

auth

auth: OnmsAuthConfig

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

parameters

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

http parameters to be passed on the URL

timeout

timeout: number = 10000

how long to wait for ReST calls to time out

Generated using TypeDoc