Class OnmsHTTPOptions

constructor

• new OnmsHTTPOptions(
      timeout?: number,
      server?: OnmsServer,
      auth?: OnmsAuthConfig,
      headers?: IHash<string>,
      parameters?: IHash<string | string[]>,
      data?: any,
  ): OnmsHTTPOptions

  Construct a new OnmsHTTPOptions object.

  Parameters

  • Optionaltimeout: number
  • Optionalserver: OnmsServer
  • Optionalauth: OnmsAuthConfig
  • Optionalheaders: IHash<string>
  • Optionalparameters: IHash<string | string[]>
  • Optionaldata: any

  Returns OnmsHTTPOptions

Readonlydata

Readonlyheaders

Readonlyparameters

Readonlyserver

auth

• get auth(): OnmsAuthConfig

  The authentication config that should be used.

  Returns OnmsAuthConfig

timeout

• get timeout(): number

  How long to wait for ReST calls to time out.

  Returns number

replace

• replace(pattern: string | RegExp, replaceWith: string): string

  Parameters

  • pattern: string | RegExp
  • replaceWith: string

  Returns string

toJSON

• toJSON(): object

  Convert the options to a plain JSON object.

  Returns object

StaticnewBuilder

• newBuilder(options?: OnmsHTTPOptions): OnmsHTTPOptionsBuilder

  Create a new builder for an [[OnmsHTTPOptions]] object.

  Parameters

  • Optionaloptions: OnmsHTTPOptions

    if an existing options object is passed, the builder will be pre-populated

  Returns OnmsHTTPOptionsBuilder