Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Biutor<SuccessData, FailData, ErrorData, SendData>

Type parameters

Hierarchy

  • Biutor

Index

Methods

Static initialize

  • initialize(options?: { isForceInitialize?: boolean }): void
  • The default request engine for environments will be resigtered automatically when script is loaded, there is no need to invoke initialize method manually except for reset engines to defaults.

    Parameters

    • options: { isForceInitialize?: boolean } = {}
      • Optional isForceInitialize?: boolean

    Returns void

Static registerGlobalEngine

Static of

  • of<SuccessData, FailData, ErrorData, SendData>(options: BiuOptions<SuccessData, FailData, ErrorData, SendData>): Biutor<SuccessData, FailData, ErrorData, SendData>

setOptions

  • setOptions<K>(key: K, value: Required<BiuOptions<SuccessData, FailData, ErrorData, SendData>>[K]): Biutor<SuccessData, FailData, ErrorData, SendData>

sendEnvironmentalRequest

  • sendEnvironmentalRequest(env: BiuRequestSupportEnvironments): Biutor<SuccessData, FailData, ErrorData, SendData>

sendWXMINARequest

  • sendWXMINARequest(): Biutor<SuccessData, FailData, ErrorData, SendData>

sendWebRequest

  • sendWebRequest(): Biutor<SuccessData, FailData, ErrorData, SendData>

sendNodeRequest

  • sendNodeRequest(): Biutor<SuccessData, FailData, ErrorData, SendData>

sendDefaultRequest

  • sendDefaultRequest(): Biutor<SuccessData, FailData, ErrorData, SendData>

sendRequest

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

Constructors

constructor

  • new Biutor<SuccessData, FailData, ErrorData, SendData>(options: BiuOptions<SuccessData, FailData, ErrorData, SendData>): Biutor<SuccessData, FailData, ErrorData, SendData>

Properties

_options

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

_response

_response: Promise<ResponseUnion<SuccessData, FailData, ErrorData>>

Private Readonly _resolve

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

Type declaration

    • Parameters

      Returns void

Private Readonly _reject

_reject: (reason?: any) => void

Type declaration

    • (reason?: any): void
    • Parameters

      • Optional reason: any

      Returns void

Accessors

options

  • get options(): BiuOptions<SuccessData, FailData, ErrorData, SendData>

response

  • get response(): Promise<ResponseUnion<SuccessData, FailData, ErrorData>>

modifiedResponse

  • get modifiedResponse(): Promise<any>

data

successData

  • get successData(): Promise<SuccessData>

failData

  • get failData(): Promise<FailData>

errorData

  • get errorData(): Promise<ErrorData>