Class Xhr

See

https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest

Hierarchy

Implements

IXHR

Properties

`Static` `Optional` disableCertificateVerification

disableCertificateVerification?: boolean

Disable certificate verification across all components that use HTTP. It can be used to bypass self-signed certificate. This property must be assigned when the application is started and cannot be changed dynamically.

Property

= false]

Android

Ios

Static

Since

5.1.1

`Static` ios

ios: { sslPinning?: { host: string; certificates: string[]; validateCertificateChain?: boolean; validateHost?: boolean }[] }

Type declaration

Optional sslPinning?: { host: string; certificates: string[]; validateCertificateChain?: boolean; validateHost?: boolean }[]

readyState

readyState: number

See

https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/readyState

response

response: null | string | object

See

https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/response

responseText

responseText: string

See

https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseText

`Optional` responseURL

responseURL?: string

See

https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseURL

status

status: number

See

https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/status

statusText

statusText: string

timeout

timeout: number

See

https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/timeout

onabort

onabort: ((...args: any[]) => void)

Type declaration

- (...args: any[]): void
- Parameters
  - Rest ...args: any[]
  Returns void

onerror

onerror: ((...args: any[]) => void)

Type declaration

- (...args: any[]): void
- Parameters
  - Rest ...args: any[]
  Returns void

onload

onload: ((...args: any[]) => void)

Type declaration

- (...args: any[]): void
- Parameters
  - Rest ...args: any[]
  Returns void

onloadend

onloadend: ((...args: any[]) => void)

Type declaration

- (...args: any[]): void
- Parameters
  - Rest ...args: any[]
  Returns void

onloadstart

onloadstart: ((...args: any[]) => void)

Type declaration

- (...args: any[]): void
- Parameters
  - Rest ...args: any[]
  Returns void

onprogress

onprogress: ((...args: any[]) => void)

Type declaration

- (...args: any[]): void
- Parameters
  - Rest ...args: any[]
  Returns void

onreadystatechange

onreadystatechange: ((...args: any[]) => void)

Type declaration

- (...args: any[]): void
- Parameters
  - Rest ...args: any[]
  Returns void

ontimeout

ontimeout: ((...args: any[]) => void)

Type declaration

- (...args: any[]): void
- Parameters
  - Rest ...args: any[]
  Returns void

Constructors

constructor

new AbstractXHR(): Xhr
Returns Xhr

Methods

on

on(eventName: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout", callback: EventListenerCallback): (() => void)
Creates an event emitter instance to listen for the actions

Returns
Call the function to remove the event
Parameters
- eventName: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout"
- callback: EventListenerCallback
  
  Gets as any arguments as it needs
Returns (() => void)
- - (): void
  - Returns void
Implementation of IXHR.on
- Defined in net/xhr/xhr.ts:147

once

once(eventName: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout", callback: EventListenerCallback): (() => void)
Creates an event emitter instance to listen for the actions

Returns
Call the function to remove the event
Parameters
- eventName: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout"
- callback: EventListenerCallback
  
  Gets as any arguments as it needs
Returns (() => void)
- - (): void
  - Returns void
Implementation of IXHR.once
- Defined in net/xhr/xhr.ts:148

off

off(eventName: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout", callback?: EventListenerCallback): void
Removes the specified event and invokes the callback after it is removed
Parameters
- eventName: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout"
- Optional callback: EventListenerCallback
Returns void
Implementation of IXHR.off
- Defined in net/xhr/xhr.ts:149

emit

emit(event: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout", ...args: any[]): void
Triggers the event manually.
Parameters
- event: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout"
- Rest ...args: any[]
  
  Arguments that needs to be passed down
Returns void
Implementation of IXHR.emit
- Defined in net/xhr/xhr.ts:150

prependListener

prependListener(eventName: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout", callback: EventListenerCallback): void
Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.
Parameters
- eventName: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout"
- callback: EventListenerCallback
Returns void
Implementation of IXHR.prependListener
- Defined in net/xhr/xhr.ts:151

prependOnceListener

prependOnceListener(eventName: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout", callback: EventListenerCallback): void
Adds a one-time listener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.
Parameters
- eventName: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout"
- callback: EventListenerCallback
Returns void
Implementation of IXHR.prependOnceListener
- Defined in net/xhr/xhr.ts:152

abort

abort(): void
See
https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/abort

Returns void
Implementation of IXHR.abort
- Defined in net/xhr/xhr.ts:153

getAllResponseHeaders

getAllResponseHeaders(): string
See
https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/getAllResponseHeaders

Returns string
Implementation of IXHR.getAllResponseHeaders
- Defined in net/xhr/xhr.ts:154

getResponseHeader

getResponseHeader(header: string): null | string
See
https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/getResponseHeader
Parameters
- header: string
Returns null | string
Implementation of IXHR.getResponseHeader
- Defined in net/xhr/xhr.ts:155

open

open(method: HTTPRequestMethods, url: string, async?: boolean, user?: string, password?: string): void
See
https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/open
Parameters
- method: HTTPRequestMethods
- url: string
- Optional async: boolean
- Optional user: string
- Optional password: string
Returns void
Implementation of IXHR.open
- Defined in net/xhr/xhr.ts:156

send

send(data?: string | FormData): void
Sends the request. If the request is asynchronous (which is the default), this method returns as soon as the request is sent.

See
https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/send
Parameters
- Optional data: string | FormData
Returns void
Implementation of IXHR.send
- Defined in net/xhr/xhr.ts:157

setRequestHeader

setRequestHeader(header: string, value: string): void
Sets the value of an HTTP request header. You must call setRequestHeader() after open(), but before send().

See
https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader
Parameters
- header: string
- value: string
Returns void
Implementation of IXHR.setRequestHeader
- Defined in net/xhr/xhr.ts:158

addEventListener

addEventListener(eventName: string, handler: ((...args: any[]) => void)): void
Parameters
- eventName: string
- handler: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Implementation of IXHR.addEventListener
- Defined in net/xhr/xhr.ts:167

removeEventListener

removeEventListener(eventName: string, toDetach: ((...args: any[]) => void)): void
Parameters
- eventName: string
- toDetach: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Implementation of IXHR.removeEventListener
- Defined in net/xhr/xhr.ts:168

Class Xhr

See

Hierarchy

Implements

Index

Properties

Constructors

Methods

Properties

Static Optional disableCertificateVerification

Property

Android

Ios

Static

Since

Static ios

Type declaration

Optional sslPinning?: { host: string; certificates: string[]; validateCertificateChain?: boolean; validateHost?: boolean }[]

readyState

See

response

See

responseText

See

Optional responseURL

See

status

See

statusText

See

responseType

See

upload

See

timeout

See

onabort

Type declaration

Parameters

Rest ...args: any[]

Returns void

onerror

Type declaration

Parameters

Rest ...args: any[]

Returns void

onload

Type declaration

Parameters

Rest ...args: any[]

Returns void

onloadend

Type declaration

Parameters

Rest ...args: any[]

Returns void

onloadstart

Type declaration

Parameters

Rest ...args: any[]

Returns void

onprogress

Type declaration

Parameters

Rest ...args: any[]

Returns void

onreadystatechange

Type declaration

Parameters

Rest ...args: any[]

Returns void

ontimeout

Type declaration

Parameters

Rest ...args: any[]

Returns void

Constructors

constructor

Returns Xhr

Methods

`Static` `Optional` disableCertificateVerification

`Static` ios

`Optional` sslPinning?: { host: string; certificates: string[]; validateCertificateChain?: boolean; validateHost?: boolean }[]

`Optional` responseURL

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` callback: EventListenerCallback

`Rest` ...args: any[]

`Optional` async: boolean

`Optional` user: string

`Optional` password: string

`Optional` data: string | FormData