Interface IXHR

See

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

Hierarchy

Implemented by

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
  - Creates an event emitter instance to listen for the actions
    
    Returns
    Call the function to remove the event
    
    Returns void
Inherited from IEventEmitter.on
- Defined in core/eventemitter/event-emitter.ts:12

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
  - Creates an event emitter instance to listen for the actions
    
    Returns
    Call the function to remove the event
    
    Returns void
Inherited from IEventEmitter.once
- Defined in core/eventemitter/event-emitter.ts:20

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
Inherited from IEventEmitter.off
- Defined in core/eventemitter/event-emitter.ts:27

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
Inherited from IEventEmitter.emit
- Defined in core/eventemitter/event-emitter.ts:34

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
Inherited from IEventEmitter.prependListener
- Defined in core/eventemitter/event-emitter.ts:41

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
Inherited from IEventEmitter.prependOnceListener
- Defined in core/eventemitter/event-emitter.ts:45

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
Inherited from XMLHttpRequestEventTarget.addEventListener
- Defined in net/xhr/xhr.ts:18

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
Inherited from XMLHttpRequestEventTarget.removeEventListener
- Defined in net/xhr/xhr.ts:19

abort

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

Returns void
Inherited from IXHRMethods.abort
- Defined in net/xhr/xhr.ts:70

getAllResponseHeaders

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

Returns string
Inherited from IXHRMethods.getAllResponseHeaders
- Defined in net/xhr/xhr.ts:74

getResponseHeader

getResponseHeader(header: string): null | string
See
https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/getResponseHeader
Parameters
- header: string
Returns null | string
Inherited from IXHRMethods.getResponseHeader
- Defined in net/xhr/xhr.ts:78

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
Inherited from IXHRMethods.open
- Defined in net/xhr/xhr.ts:82

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
Inherited from IXHRMethods.send
- Defined in net/xhr/xhr.ts:87

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
Inherited from IXHRMethods.setRequestHeader
- Defined in net/xhr/xhr.ts:92

Properties

onabort

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

Type declaration

- (...args: any[]): void
- Fired when a request has been aborted, for example because the program called XMLHttpRequest.abort(). Also available via the onabort event handler property.
  
  See
  https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/abort_event
  Parameters
  - Rest ...args: any[]
  Returns void

onerror

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

Type declaration

- (...args: any[]): void
- Fired when the request encountered an error. Also available via the onerror event handler property.
  
  See
  https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/error_event
  Parameters
  - Rest ...args: any[]
  Returns void

onload

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

Type declaration

- (...args: any[]): void
- Fired when an XMLHttpRequest transaction completes successfully. Also available via the onload event handler property.
  
  See
  https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/load_event
  Parameters
  - Rest ...args: any[]
  Returns void

onloadend

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

Type declaration

- (...args: any[]): void
- Fired when a request has completed, whether successfully (after load) or unsuccessfully (after abort or error). Also available via the onloadend event handler property.
  
  See
  https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/loadend_event
  Parameters
  - Rest ...args: any[]
  Returns void

onloadstart

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

Type declaration

- (...args: any[]): void
- Fired when a request has started to load data. Also available via the onloadstart event handler property.
  
  See
  https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/loadstart_event
  Parameters
  - Rest ...args: any[]
  Returns void

onprogress

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

Type declaration

- (...args: any[]): void
- Fired periodically when a request receives more data. Also available via the onprogress event handler property.
  
  See
  https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/progress_event
  Parameters
  - Rest ...args: any[]
  Returns void

onreadystatechange

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

Type declaration

- (...args: any[]): void
- Fired whenever the readyState property changes. Also available via the onreadystatechange event handler property.
  
  See
  https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/readystatechange_event
  Parameters
  - Rest ...args: any[]
  Returns void

ontimeout

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

Type declaration

- (...args: any[]): void
- Fired when progress is terminated due to preset time expiring. Also available via the ontimeout event handler property.
  
  See
  https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/timeout_event
  Parameters
  - Rest ...args: any[]
  Returns void

`Readonly` readyState

readyState: number

See

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

`Readonly` response

response: null | string | object

See

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

`Readonly` responseText

responseText: string

See

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

`Optional` `Readonly` responseURL

responseURL?: string

See

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

`Readonly` status

status: number

See

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

`Readonly` statusText

statusText: string

timeout

timeout: number

See

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

Interface IXHR

See

Hierarchy

Implemented by

Index

Methods

Properties

Methods

on

Returns

Parameters

eventName: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout"

callback: EventListenerCallback

Returns (() => void)

Returns

Returns void

once

Returns

Parameters

eventName: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout"

callback: EventListenerCallback

Returns (() => void)

Returns

Returns void

off

Parameters

eventName: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout"

Optional callback: EventListenerCallback

Returns void

emit

Parameters

event: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout"

Rest ...args: any[]

Returns void

prependListener

Parameters

eventName: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout"

callback: EventListenerCallback

Returns void

prependOnceListener

Parameters

eventName: "abort" | "error" | "load" | "loadend" | "loadstart" | "progress" | "readystatechange" | "timeout"

callback: EventListenerCallback

Returns void

addEventListener

Parameters

eventName: string

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

Parameters

Rest ...args: any[]

Returns void

Returns void

removeEventListener

Parameters

eventName: string

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

Parameters

Rest ...args: any[]

Returns void

Returns void

abort

See

Returns void

getAllResponseHeaders

See

Returns string

getResponseHeader

See

Parameters

header: string

Returns null | string

open

See

Parameters

method: HTTPRequestMethods

url: string

Optional async: boolean

Optional user: string

Optional password: string

Returns void

`Optional` callback: EventListenerCallback

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` async: boolean

`Optional` user: string

`Optional` password: string

`Optional` data: string | FormData

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Readonly` readyState

`Readonly` response

`Readonly` responseText

`Optional` `Readonly` responseURL

`Readonly` status