Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OnmsHTTPOptions

Options to be used when making HTTP ReST calls.

Hierarchy

  • OnmsHTTPOptions

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private __computed

__computed: OnmsAuthConfig

data

data: any

HTTP data to be passed when POSTing

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.

Accessors

auth

timeout

  • get timeout(): number
  • set timeout(t: number): void

Methods

toJSON

  • toJSON(): object

withParameter

  • Add a URL parameter. Returns the OnmsHTTPOptions object so it can be chained.

    Parameters

    • key: string

      the parameter's key

    • Optional value: any

      the parameter's value

    Returns OnmsHTTPOptions

Generated using TypeDoc