Options
All
  • Public
  • Public/Protected
  • All
Menu

Options to be used when making HTTP ReST calls.

Hierarchy

  • OnmsHTTPOptions

Index

Constructors

Properties

[AUTH_PROP]: API.OnmsAuthConfig

The default authentication credentials associated with these options.

This is a trick for making sure serialization to JSON happens properly without exposing internals.

[TIMEOUT_PROP]: number

The default timeout associated with these options.

This is a trick for making sure serialization to JSON happens properly without exposing internals.

data: any

HTTP data to be passed when POSTing

headers: API.IHash<string> = ...

HTTP headers to be passed to the request.

parameters: API.IHash<string | string[]> = ...

HTTP parameters to be passed on the URL.

server: API.OnmsServer

The server to use instead of that provided by the HTTP implementation.

Accessors

  • get timeout(): number

Methods

  • toJSON(): object

Generated using TypeDoc