Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApiResult

An ApiResult object contains response information about an API request.

Hierarchy

  • ApiResult

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ApiResult(response: any, data: any, error: any, params?: any): ApiResult
  • Initializes a result instance with the necessary response information.

    memberof

    ApiResult

    Parameters

    • response: any
    • data: any
    • error: any
    • Default value params: any = null

    Returns ApiResult

Properties

data

data: any

Response data provided by the API.

memberof

ApiResult

error

error: any

Error that occurred during the request, if any.

memberof

ApiResult

params

params: any

Request parameters that were used.

memberof

ApiResult

response

response: any

Response object returned by the request.

memberof

ApiResult

warning

warning: any

Warning that occurred during the request, if any.

The AerisWeather API will sometimes include warnings with the response if there was an issue with the request or parameters that didn't prevent the request completely.

memberof

ApiResult

Methods

headers

  • headers(): any
  • Returns the headers returned by the response, if any.

    memberof

    ApiResult

    Returns any

Generated using TypeDoc