Class ApiRequest

An object that is responsible for configuring and performing a single request to the Aeris Weather API.

export

Hierarchy

ApiRequest

Index

Constructors

constructor

Accessors

requests

Methods

Object literals

config

Constructors

constructor

new ApiRequest(config: ApiConfig, opts?: ApiRequestOptions): ApiRequest

- Defined in src/network/api/ApiRequest.ts:73
Initializes a new request instance configured with the specified client access keys.

memberof

ApiRequest

Parameters
- config: ApiConfig
- Optional opts: ApiRequestOptions
Returns ApiRequest

Accessors

requests

get requests(): ApiRequest[]

- Defined in src/network/api/ApiRequest.ts:71
Returns ApiRequest[]

Methods

action

action(action: ApiAction): ApiRequest

- Defined in src/network/api/ApiRequest.ts:190
Sets the action for the request.

memberof

ApiRequest

Parameters
- action: ApiAction
Returns ApiRequest

addRequest

addRequest(request: ApiRequest): ApiRequest

- Defined in src/network/api/ApiRequest.ts:465
Adds a request to the batch request.

Adding child requests to this request automatically converts the containing request to a batch request.

memberof

ApiRequest

Parameters
- request: ApiRequest
Returns ApiRequest

bounds

bounds(bounds: GeoBounds): ApiRequest

- Defined in src/network/api/ApiRequest.ts:224
Sets the request's place to the coordinate bounds string.

memberof

ApiRequest

Parameters
- bounds: GeoBounds
Returns ApiRequest

cancel

cancel(): void

- Defined in src/network/api/ApiRequest.ts:551
Cancels any active request.

memberof

ApiRequest

Returns void

clone

clone(): ApiRequest

- Defined in src/network/api/ApiRequest.ts:608
Returns a copy of the request.

memberof

ApiRequest

Returns ApiRequest

endpoint

endpoint(endpoint: string): ApiRequest

- Defined in src/network/api/ApiRequest.ts:167
Sets the endpoint for the request (required).

memberof

ApiRequest

Parameters
- endpoint: string
Returns ApiRequest

fields

fields(value: string): ApiRequest

- Defined in src/network/api/ApiRequest.ts:309
Sets the fields parameter.

memberof

ApiRequest

Parameters
- value: string
Returns ApiRequest

filter

filter(value: string): ApiRequest

- Defined in src/network/api/ApiRequest.ts:297
Sets the filter parameter.

memberof

ApiRequest

Parameters
- value: string
Returns ApiRequest

format

format(value: string): ApiRequest

- Defined in src/network/api/ApiRequest.ts:444
Sets the format parameters.

memberof

ApiRequest

Parameters
- value: string
Returns ApiRequest

from

from(value: string | Date): ApiRequest

- Defined in src/network/api/ApiRequest.ts:360
Sets the from parameter.

memberof

ApiRequest

Parameters
- value: string | Date
Returns ApiRequest

get

get(callback?: (result: ApiResult) => void): Promise<ApiResult>

- Defined in src/network/api/ApiRequest.ts:517
Perform the request.

memberof

ApiRequest

Parameters
- Optional callback: (result: ApiResult) => void
  - - (result: ApiResult): void
    - Parameters
      - result: ApiResult
      Returns void
Returns Promise<ApiResult>

getAction

getAction(): ApiAction

- Defined in src/network/api/ApiRequest.ts:201
Returns the action for the request.

memberof

ApiRequest

Returns ApiAction

getEndpoint

getEndpoint(): string

- Defined in src/network/api/ApiRequest.ts:179
Returns the endpoint for the request.

memberof

ApiRequest

Returns string

getParams

getParams(): ApiRequestOptions

- Defined in src/network/api/ApiRequest.ts:128
Returns the current request parameters.

memberof

ApiRequest

Returns ApiRequestOptions

limit

limit(value: number): ApiRequest

- Defined in src/network/api/ApiRequest.ts:246
Sets the limit parameter.

memberof

ApiRequest

Parameters
- value: number
Returns ApiRequest

lod

lod(value: number): ApiRequest

- Defined in src/network/api/ApiRequest.ts:258
Sets the lod (level-of-detail) parameter.

memberof

ApiRequest

Parameters
- value: number
Returns ApiRequest

mindist

mindist(value: string | number): ApiRequest

- Defined in src/network/api/ApiRequest.ts:270
Sets the mindist parameter.

memberof

ApiRequest

Parameters
- value: string | number
Returns ApiRequest

param

param(key: string, value?: any): ApiRequest | any

- Defined in src/network/api/ApiRequest.ts:111
Sets or returns the specified parameter.

memberof

ApiRequest

Parameters
- key: string
- Optional value: any
Returns ApiRequest | any

place

place(value: string): ApiRequest

- Defined in src/network/api/ApiRequest.ts:212
Sets the place for the request.

memberof

ApiRequest

Parameters
- value: string
Returns ApiRequest

plimit

plimit(value: number): ApiRequest

- Defined in src/network/api/ApiRequest.ts:408
Sets the plimit paramter.

memberof

ApiRequest

Parameters
- value: number
Returns ApiRequest

pskip

pskip(value: number): ApiRequest

- Defined in src/network/api/ApiRequest.ts:432
Sets the pskip parameter.

memberof

ApiRequest

Parameters
- value: number
Returns ApiRequest

psort

psort(value: string): ApiRequest

- Defined in src/network/api/ApiRequest.ts:420
Sets the psort parameter.

memberof

ApiRequest

Parameters
- value: string
Returns ApiRequest

query

query(value: string | Query): ApiRequest

- Defined in src/network/api/ApiRequest.ts:321
Sets the query parameter.

memberof

ApiRequest

Parameters
- value: string | Query
Returns ApiRequest

radius

radius(value: string): ApiRequest

- Defined in src/network/api/ApiRequest.ts:285
Sets the radius parameter.

memberof

ApiRequest

Parameters
- value: string
Returns ApiRequest

removeAllRequests

removeAllRequests(): void

- Defined in src/network/api/ApiRequest.ts:506
Removes all requests from the batch request, converting the request instance to a non-batch request.

memberof

ApiRequest

Returns void

removeRequest

removeRequest(request: ApiRequest): ApiRequest

- Defined in src/network/api/ApiRequest.ts:493
Removes a request from the batch request.

memberof

ApiRequest

Parameters
- request: ApiRequest
Returns ApiRequest

resetParams

resetParams(): ApiRequest

- Defined in src/network/api/ApiRequest.ts:155
Returns ApiRequest

route

route(value: any): ApiRequest

- Defined in src/network/api/ApiRequest.ts:449
Parameters
- value: any
Returns ApiRequest

setParams

setParams(params: ApiRequestOptions): ApiRequest

- Defined in src/network/api/ApiRequest.ts:139
Sets multiple request parameters.

memberof

ApiRequest

Parameters
- params: ApiRequestOptions
Returns ApiRequest

skip

skip(value: number): ApiRequest

- Defined in src/network/api/ApiRequest.ts:348
Sets the skip parameter.

memberof

ApiRequest

Parameters
- value: number
Returns ApiRequest

sort

sort(value: string): ApiRequest

- Defined in src/network/api/ApiRequest.ts:336
Sets the sort parameter.

memberof

ApiRequest

Parameters
- value: string
Returns ApiRequest

to

to(value: string | Date): ApiRequest

- Defined in src/network/api/ApiRequest.ts:384
Sets the to parameter.

memberof

ApiRequest

Parameters
- value: string | Date
Returns ApiRequest

url

url(isBatch?: boolean): string

- Defined in src/network/api/ApiRequest.ts:562
Returns the url string for the request based on the configured parameters and options.

memberof

ApiRequest

Parameters
- Default value isBatch: boolean = false
Returns string

Object literals

config

config: object

Base configuration for the request.

memberof: ApiRequest

server

server: string = "https://data.api.xweather.com"

client

client: object

id

id: undefined = undefined

secret

secret: undefined = undefined

Generated using TypeDoc