JQueryXHR | ngTable API Reference

Interface for the jqXHR object

Hierarchy

XMLHttpRequest
JQueryPromise<any>
- JQueryXHR

Index

Properties

Methods

Properties

DONE

DONE: number

HEADERS_RECEIVED

HEADERS_RECEIVED: number

LOADING

LOADING: number

OPENED

OPENED: number

UNSENT

UNSENT: number

XMLHttpRequest

XMLHttpRequest: object

Type declaration

constructor: function
- new __type(): __type
- - Defined in node_modules/typescript/lib/lib.d.ts:17317
  Returns __type
DONE: number
HEADERS_RECEIVED: number
LOADING: number
OPENED: number
UNSENT: number
prototype: XMLHttpRequest
create: function
- create(): XMLHttpRequest
- - Defined in node_modules/typescript/lib/lib.d.ts:17324
  Returns XMLHttpRequest

Optional msCaching

msCaching: string

onabort

onabort: function

Type declaration

- (this: , ev: Event): any
- Parameters
  - this:
  - ev: Event
  Returns any

onerror

onerror: function

Type declaration

- (this: , ev: ErrorEvent): any
- Parameters
  - this:
  - ev: ErrorEvent
  Returns any

onload

onload: function

Type declaration

- (this: , ev: Event): any
- Parameters
  - this:
  - ev: Event
  Returns any

onloadend

onloadend: function

Type declaration

- (this: , ev: ProgressEvent): any
- Parameters
  - this:
  - ev: ProgressEvent
  Returns any

onloadstart

onloadstart: function

Type declaration

- (this: , ev: Event): any
- Parameters
  - this:
  - ev: Event
  Returns any

onprogress

onprogress: function

Type declaration

- (this: , ev: ProgressEvent): any
- Parameters
  - this:
  - ev: ProgressEvent
  Returns any

onreadystatechange

onreadystatechange: function

Type declaration

- (this: , ev: ProgressEvent): any
- Parameters
  - this:
  - ev: ProgressEvent
  Returns any

ontimeout

ontimeout: function

Type declaration

- (this: , ev: ProgressEvent): any
- Parameters
  - this:
  - ev: ProgressEvent
  Returns any

readyState

readyState: number

response

response: any

Optional responseJSON

responseJSON: any

Property containing the parsed response if the response Content-Type is json

responseText

responseText: string

responseType

responseType: string

responseXML

responseXML: any

status

status: number

statusText

statusText: string

timeout

timeout: number

upload

upload: XMLHttpRequestUpload

withCredentials

withCredentials: boolean

Methods

abort

abort(statusText?: string): void

Overwrites XMLHttpRequest.abort
- Defined in node_modules/@types/jquery/index.d.ts:179
Cancel the request.

Parameters
- Optional statusText: string
  
  A string passed as the textStatus parameter for the done callback. Default value: "canceled"
Returns void

addEventListener

addEventListener(type: "abort", listener: function, useCapture?: boolean): void
addEventListener(type: "error", listener: function, useCapture?: boolean): void
addEventListener(type: "load", listener: function, useCapture?: boolean): void
addEventListener(type: "loadend", listener: function, useCapture?: boolean): void
addEventListener(type: "loadstart", listener: function, useCapture?: boolean): void
addEventListener(type: "progress", listener: function, useCapture?: boolean): void
addEventListener(type: "readystatechange", listener: function, useCapture?: boolean): void
addEventListener(type: "timeout", listener: function, useCapture?: boolean): void
addEventListener(type: string, listener: EventListenerOrEventListenerObject, useCapture?: boolean): void

Inherited from XMLHttpRequest.addEventListener

Overwrites EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.d.ts:17305
Parameters
- type: "abort"
- listener: function
  - - (this: , ev: Event): any
    - Parameters
      - this:
      - ev: Event
      Returns any
- Optional useCapture: boolean
Returns void
Inherited from XMLHttpRequest.addEventListener

Overwrites EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.d.ts:17306
Parameters
- type: "error"
- listener: function
  - - (this: , ev: ErrorEvent): any
    - Parameters
      - this:
      - ev: ErrorEvent
      Returns any
- Optional useCapture: boolean
Returns void
Inherited from XMLHttpRequest.addEventListener

Overwrites EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.d.ts:17307
Parameters
- type: "load"
- listener: function
  - - (this: , ev: Event): any
    - Parameters
      - this:
      - ev: Event
      Returns any
- Optional useCapture: boolean
Returns void
Inherited from XMLHttpRequest.addEventListener

Overwrites EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.d.ts:17308
Parameters
- type: "loadend"
- listener: function
  - - (this: , ev: ProgressEvent): any
    - Parameters
      - this:
      - ev: ProgressEvent
      Returns any
- Optional useCapture: boolean
Returns void
Inherited from XMLHttpRequest.addEventListener

Overwrites EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.d.ts:17309
Parameters
- type: "loadstart"
- listener: function
  - - (this: , ev: Event): any
    - Parameters
      - this:
      - ev: Event
      Returns any
- Optional useCapture: boolean
Returns void
Inherited from XMLHttpRequest.addEventListener

Overwrites EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.d.ts:17310
Parameters
- type: "progress"
- listener: function
  - - (this: , ev: ProgressEvent): any
    - Parameters
      - this:
      - ev: ProgressEvent
      Returns any
- Optional useCapture: boolean
Returns void
Inherited from XMLHttpRequest.addEventListener

Overwrites EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.d.ts:17311
Parameters
- type: "readystatechange"
- listener: function
  - - (this: , ev: ProgressEvent): any
    - Parameters
      - this:
      - ev: ProgressEvent
      Returns any
- Optional useCapture: boolean
Returns void
Inherited from XMLHttpRequest.addEventListener

Overwrites EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.d.ts:17312
Parameters
- type: "timeout"
- listener: function
  - - (this: , ev: ProgressEvent): any
    - Parameters
      - this:
      - ev: ProgressEvent
      Returns any
- Optional useCapture: boolean
Returns void
Inherited from XMLHttpRequest.addEventListener

Overwrites EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.d.ts:17313
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional useCapture: boolean
Returns void

always

always(alwaysCallback1?: JQueryPromiseCallback<any> | JQueryPromiseCallback<any>[], ...alwaysCallbacksN: Array<JQueryPromiseCallback<any> | JQueryPromiseCallback<any>[]>): JQueryPromise<any>

Inherited from JQueryPromise.always
- Defined in node_modules/@types/jquery/index.d.ts:323
Add handlers to be called when the Deferred object is either resolved or rejected.

Parameters
- Optional alwaysCallback1: JQueryPromiseCallback<any> | JQueryPromiseCallback<any>[]
- Rest ...alwaysCallbacksN: Array<JQueryPromiseCallback<any> | JQueryPromiseCallback<any>[]>
Returns JQueryPromise<any>

dispatchEvent

dispatchEvent(evt: Event): boolean

Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typescript/lib/lib.d.ts:7911
Parameters
- evt: Event
Returns boolean

done

done(doneCallback1?: JQueryPromiseCallback<any> | JQueryPromiseCallback<any>[], ...doneCallbackN: Array<JQueryPromiseCallback<any> | JQueryPromiseCallback<any>[]>): JQueryPromise<any>

Inherited from JQueryPromise.done
- Defined in node_modules/@types/jquery/index.d.ts:330
Add handlers to be called when the Deferred object is resolved.

Parameters
- Optional doneCallback1: JQueryPromiseCallback<any> | JQueryPromiseCallback<any>[]
- Rest ...doneCallbackN: Array<JQueryPromiseCallback<any> | JQueryPromiseCallback<any>[]>
Returns JQueryPromise<any>

error

error(xhr: JQueryXHR, textStatus: string, errorThrown: string): void

- Defined in node_modules/@types/jquery/index.d.ts:191
A function to be called if the request fails.

Parameters
- xhr: JQueryXHR
- textStatus: string
- errorThrown: string
Returns void

fail

fail(failCallback1?: JQueryPromiseCallback<any> | JQueryPromiseCallback<any>[], ...failCallbacksN: Array<JQueryPromiseCallback<any> | JQueryPromiseCallback<any>[]>): JQueryPromise<any>

Inherited from JQueryPromise.fail
- Defined in node_modules/@types/jquery/index.d.ts:337
Add handlers to be called when the Deferred object is rejected.

Parameters
- Optional failCallback1: JQueryPromiseCallback<any> | JQueryPromiseCallback<any>[]
- Rest ...failCallbacksN: Array<JQueryPromiseCallback<any> | JQueryPromiseCallback<any>[]>
Returns JQueryPromise<any>

getAllResponseHeaders

getAllResponseHeaders(): string

Inherited from XMLHttpRequest.getAllResponseHeaders
- Defined in node_modules/typescript/lib/lib.d.ts:17291
Returns string

getResponseHeader

getResponseHeader(header: string): string | null

Inherited from XMLHttpRequest.getResponseHeader
- Defined in node_modules/typescript/lib/lib.d.ts:17292
Parameters
- header: string
Returns string | null

msCachingEnabled

msCachingEnabled(): boolean

Inherited from XMLHttpRequest.msCachingEnabled
- Defined in node_modules/typescript/lib/lib.d.ts:17293
Returns boolean

open

open(method: string, url: string, async?: boolean, user?: string, password?: string): void

Inherited from XMLHttpRequest.open
- Defined in node_modules/typescript/lib/lib.d.ts:17294
Parameters
- method: string
- url: string
- Optional async: boolean
- Optional user: string
- Optional password: string
Returns void

overrideMimeType

overrideMimeType(mimeType: string): any

Overwrites XMLHttpRequest.overrideMimeType
- Defined in node_modules/@types/jquery/index.d.ts:173
The .overrideMimeType() method may be used in the beforeSend() callback function, for example, to modify the response content-type header. As of jQuery 1.5.1, the jqXHR object also contains the overrideMimeType() method (it was available in jQuery 1.4.x, as well, but was temporarily removed in jQuery 1.5).

Parameters
- mimeType: string
Returns any

pipe

pipe(doneFilter?: function, failFilter?: function, progressFilter?: function): JQueryPromise<any>

Inherited from JQueryPromise.pipe
- Defined in node_modules/@types/jquery/index.d.ts:346
Parameters
- Optional doneFilter: function
  - - (x: any): any
    - Parameters
      - x: any
      Returns any
- Optional failFilter: function
  - - (x: any): any
    - Parameters
      - x: any
      Returns any
- Optional progressFilter: function
  - - (x: any): any
    - Parameters
      - x: any
      Returns any
Returns JQueryPromise<any>

progress

progress(progressCallback1?: JQueryPromiseCallback<any> | JQueryPromiseCallback<any>[], ...progressCallbackN: Array<JQueryPromiseCallback<any> | JQueryPromiseCallback<any>[]>): JQueryPromise<any>

Inherited from JQueryPromise.progress
- Defined in node_modules/@types/jquery/index.d.ts:343
Add handlers to be called when the Deferred object generates progress notifications.

Parameters
- Optional progressCallback1: JQueryPromiseCallback<any> | JQueryPromiseCallback<any>[]
- Rest ...progressCallbackN: Array<JQueryPromiseCallback<any> | JQueryPromiseCallback<any>[]>
Returns JQueryPromise<any>

removeEventListener

removeEventListener(type: string, listener?: EventListenerOrEventListenerObject, useCapture?: boolean): void

Inherited from EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.d.ts:7912
Parameters
- type: string
- Optional listener: EventListenerOrEventListenerObject
- Optional useCapture: boolean
Returns void

send

send(data?: Document): void
send(data?: string): void
send(data?: any): void

Inherited from XMLHttpRequest.send
- Defined in node_modules/typescript/lib/lib.d.ts:17296
Parameters
- Optional data: Document
Returns void
Inherited from XMLHttpRequest.send
- Defined in node_modules/typescript/lib/lib.d.ts:17297
Parameters
- Optional data: string
Returns void
Inherited from XMLHttpRequest.send
- Defined in node_modules/typescript/lib/lib.d.ts:17298
Parameters
- Optional data: any
Returns void

setRequestHeader

setRequestHeader(header: string, value: string): void

Inherited from XMLHttpRequest.setRequestHeader
- Defined in node_modules/typescript/lib/lib.d.ts:17299
Parameters
- header: string
- value: string
Returns void

state

state(): string

Inherited from JQueryPromise.state
- Defined in node_modules/@types/jquery/index.d.ts:316
Determine the current state of a Deferred object.

Returns string

then

then<R>(doneCallback: function, failCallback?: function): JQueryPromise<R>

Overwrites JQueryGenericPromise.then
- Defined in node_modules/@types/jquery/index.d.ts:183
Incorporates the functionality of the .done() and .fail() methods, allowing (as of jQuery 1.8) the underlying Promise to be manipulated. Refer to deferred.then() for implementation details.

Type parameters
- R
Parameters
- doneCallback: function
  - - (data: any, textStatus: string, jqXHR: JQueryXHR): R
    - Parameters
      - data: any
      - textStatus: string
      - jqXHR: JQueryXHR
      Returns R
- Optional failCallback: function
  - - (jqXHR: JQueryXHR, textStatus: string, errorThrown: any): void
    - Parameters
      - jqXHR: JQueryXHR
      - textStatus: string
      - errorThrown: any
      Returns void
Returns JQueryPromise<R>

Hierarchy

Index

Properties

Methods

Properties

DONE

HEADERS_RECEIVED

LOADING

OPENED

UNSENT

XMLHttpRequest

Type declaration

constructor: function

Returns __type

DONE: number

HEADERS_RECEIVED: number

LOADING: number

OPENED: number

UNSENT: number

prototype: XMLHttpRequest

create: function

Returns XMLHttpRequest

Optional msCaching

onabort

Type declaration

Parameters

this:

ev: Event

Returns any

onerror

Type declaration

Parameters

this:

ev: ErrorEvent

Returns any

onload

Type declaration

Parameters

this:

ev: Event

Returns any

onloadend

Type declaration

Parameters

this:

ev: ProgressEvent

Returns any

onloadstart

Type declaration

Parameters

this:

ev: Event

Returns any

onprogress

Type declaration

Parameters

this:

ev: ProgressEvent

Returns any

onreadystatechange

Type declaration

Parameters

this:

ev: ProgressEvent

Returns any

ontimeout

Type declaration

Parameters

this:

ev: ProgressEvent

Returns any

readyState

response

Optional responseJSON

responseText

responseType

responseXML

status

statusText

timeout