Class Request<Return_Type, Error_Handler>

API request

Type Parameters

Return_Type = any
Error_Handler = never

Hierarchy

Request

Constructors

constructor

new Request<Return_Type, Error_Handler>(params): Request<Return_Type, Error_Handler>
Constructor
Type Parameters
- Return_Type = any
- Error_Handler = never
Parameters
- params: RequestParams<Return_Type, Error_Handler>
  Request parameters
Returns Request<Return_Type, Error_Handler>
- Defined in request.ts:227

Properties

`Private` _onCancel

_onCancel: (() => void)

Type declaration

- (): void
- Cancel callback
  
  Returns void

`Private` _onRequestError

_onRequestError: ((error, handleError) => void)

Type declaration

- (error, handleError): void
- Request error callback
  Parameters
  - error: RequestError
  - handleError: ((err, handler) => void)
    - (err, handler): void
      Parameters
      err: RequestError
      handler: Error_Handler
      Returns void
  Returns void

`Private` _onSuccess

_onSuccess: ((response) => void)

Type declaration

- (response): void
- Success callback
  Parameters
  - response: Return_Type
  Returns void

`Private` _onUnexpectedError

_onUnexpectedError: ((error) => void)

Type declaration

- (error): void
- Unexpected error callback
  Parameters
  - error: Error
  Returns void

`Private` _onUploadProgress

_onUploadProgress: ((loaded, total) => void)

Type declaration

- (loaded, total): void
- Upload progress callback
  Parameters
  - loaded: number
  - total: number
  Returns void

`Private` `Optional` abortController

abortController?: AbortController

Abort controller

`Private` `Optional` aborted

aborted?: boolean

True if aborted

`Optional` `Readonly` form

form?: FormData

Request body as multipart/form-data

`Readonly` handleError

handleError: ((err, handler) => void)

Type declaration

- (err, handler): void
- Function to handle request errors
  Parameters
  - err: RequestError
  - handler: Error_Handler
  Returns void

`Optional` `Readonly` headers

headers?: RequestHeaders

Request extra headers

`Optional` `Readonly` json

json?: any

Request body (will be sent as JSON)

`Readonly` method

method: RequestMethod

Request method

`Optional` sent

sent?: boolean

True if sent

`Readonly` url

url: string

Request URL

`Private` `Optional` xhr

xhr?: XMLHttpRequest

XMLHttpRequest

Methods

abort

abort(): void
Aborts the request

Returns void
- Defined in request.ts:311

onCancel

onCancel(fn): Request<Return_Type, Error_Handler>
Sets the callback for cancel
Parameters
- fn: (() => void)
  Function to handle the cancellation event
  - - (): void
    - Returns void
Returns Request<Return_Type, Error_Handler>
Self
- Defined in request.ts:251

onRequestError

onRequestError(fn): Request<Return_Type, Error_Handler>
Sets the callback for request error
Parameters
- fn: ((error, handleError) => void)
  Function to handle the error
  - - (error, handleError): void
    - Parameters
      error: RequestError
      handleError: ((err, handler) => void)
      (err, handler): void
      Parameters
      err: RequestError
      handler: Error_Handler
      Returns void
      Returns void
Returns Request<Return_Type, Error_Handler>
Self
- Defined in request.ts:261

onSuccess

onSuccess(fn): Request<Return_Type, Error_Handler>
Sets the callback for success
Parameters
- fn: ((response) => void)
  Function to handle the data returned by the API
  - - (response): void
    - Parameters
      response: Return_Type
      Returns void
Returns Request<Return_Type, Error_Handler>
Self
- Defined in request.ts:241

onUnexpectedError

onUnexpectedError(fn): Request<Return_Type, Error_Handler>
Sets the callback for unexpected error
Parameters
- fn: ((err) => void)
  Function to handle the error
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Request<Return_Type, Error_Handler>
Self
- Defined in request.ts:273

onUploadProgress

onUploadProgress(fn): Request<Return_Type, Error_Handler>
Sets the callback for upload progress
Parameters
- fn: ((loaded, total) => void)
  Function to handle the upload progress
  - - (loaded, total): void
    - Parameters
      loaded: number
      total: number
      Returns void
Returns Request<Return_Type, Error_Handler>
Self
- Defined in request.ts:283

send

send(callback?): void
Send the request
Parameters
- Optional callback: (() => void)
  A function to call when the request is finished
  - - (): void
    - Returns void
Returns void
- Defined in request.ts:292

`Private` sendAsFetch

sendAsFetch(callback?): Promise<void>
Sends the request with the 'fetch' method
Parameters
- Optional callback: (() => void)
  A function to call when the request is finished
  - - (): void
    - Returns void
Returns Promise<void>
- Defined in request.ts:328

`Private` sendAsMultipartFormData

sendAsMultipartFormData(callback?): void
Sends the request with XMLHttpRequest for multipart requests
Parameters
- Optional callback: (() => void)
  A function to call when the request is finished
  - - (): void
    - Returns void
Returns void
- Defined in request.ts:449

`Static` Abort

Abort(name): void
Aborts a named pending request
Parameters
- name: string
  The request name
Returns void
- Defined in request.ts:137

`Static` Do

Do<R, E>(req): Request<R, E>
Sends API request
Type Parameters
- R = any
- E = never
Parameters
- req: RequestParams<R, E>
  The request parameters
Returns Request<R, E>
The request
- Defined in request.ts:118

`Static` ErrorHandler

ErrorHandler(): RequestErrorHandler
Creates a new error handler instance

Returns RequestErrorHandler
- Defined in request.ts:144

`Static` Pending

Pending<R, E>(name, req): Request<R, E>
Sends API request with a name. If another request was pending with the same name, it is aborted.
Type Parameters
- R = any
- E = never
Parameters
- name: string
  The request name
- req: RequestParams<R, E>
  The request parameters
Returns Request<R, E>
The request
- Defined in request.ts:129

Class Request<Return_Type, Error_Handler>

Type Parameters

Return_Type = any

Error_Handler = never

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Return_Type = any

Error_Handler = never

Parameters

params: RequestParams<Return_Type, Error_Handler>

Returns Request<Return_Type, Error_Handler>

Properties

Private _onCancel

Type declaration

Returns void

Private _onRequestError

Type declaration

Parameters

error: RequestError

handleError: ((err, handler) => void)

Parameters

err: RequestError

handler: Error_Handler

Returns void

Returns void

Private _onSuccess

Type declaration

Parameters

response: Return_Type

Returns void

Private _onUnexpectedError

Type declaration

Parameters

error: Error

Returns void

Private _onUploadProgress

Type declaration

Parameters

loaded: number

total: number

Returns void

Private Optional abortController

Private Optional aborted

Optional Readonly form

Readonly handleError

Type declaration

Parameters

err: RequestError

handler: Error_Handler

Returns void

Optional Readonly headers

Optional Readonly json

Readonly method

Optional sent

Readonly url

Private Optional xhr

Methods

abort

Returns void

onCancel

Parameters

fn: (() => void)

Returns void

Returns Request<Return_Type, Error_Handler>

onRequestError

Parameters

fn: ((error, handleError) => void)

Parameters

error: RequestError

handleError: ((err, handler) => void)

Parameters

err: RequestError

handler: Error_Handler

Returns void

`Private` _onCancel

`Private` _onRequestError

`Private` _onSuccess

`Private` _onUnexpectedError

`Private` _onUploadProgress

`Private` `Optional` abortController

`Private` `Optional` aborted

`Optional` `Readonly` form

`Readonly` handleError

`Optional` `Readonly` headers

`Optional` `Readonly` json

`Readonly` method

`Optional` sent

`Readonly` url

`Private` `Optional` xhr

`Optional` callback: (() => void)

`Private` sendAsFetch

`Optional` callback: (() => void)

`Private` sendAsMultipartFormData

`Optional` callback: (() => void)

`Static` Abort

`Static` Do

`Static` ErrorHandler

`Static` Pending