Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RequestEngine<SuccessData, FailData, ErrorData, SendData>

The Request Engine base class. Every Request Engine class should extend this class.

There are four required properties or methods to be implemented:

member

isRequestEngineClass - should be a static get property that always returns true.

member

environment - should be a static get property that indicates which environment the engine is designed for.

member

environment - should be a get property that indicates which environment the engine is designed for.

member

sendRequest - should be a method that actually handle the request, send request described by this._options, then invoke this._resolve or this._reject according to the response.

Type parameters

Hierarchy

Index

Accessors

Static isRequestEngineClass

  • get isRequestEngineClass(): true

isRequestEngine

  • get isRequestEngine(): true

Abstract environment

  • get environment(): BiuRequestSupportEnvironments

Constructors

constructor

  • new RequestEngine<SuccessData, FailData, ErrorData, SendData>(options: Required<BiuOptions<SuccessData, FailData, ErrorData, SendData>>, contexts: RequestEngineContexts<SuccessData, FailData, ErrorData, SendData>): RequestEngine<SuccessData, FailData, ErrorData, SendData>

Properties

_options

_options: Required<BiuOptions<SuccessData, FailData, ErrorData, SendData>>

_resolve

_resolve: (value: ResponseUnion<SuccessData, FailData, ErrorData> | PromiseLike<ResponseUnion<SuccessData, FailData, ErrorData>>) => void

Type declaration

    • Parameters

      Returns void

_reject

_reject: (reason?: any) => void

Type declaration

    • (reason?: any): void
    • Parameters

      • Optional reason: any

      Returns void

Methods

Abstract sendRequest

  • sendRequest(): RequestEngine<SuccessData, FailData, ErrorData, SendData>

formatParsedDataToResponse

  • formatParsedDataToResponse(parsedData: any): ResponseUnion<SuccessData, FailData, ErrorData>