---
title: "AjaxOptions"
---
# AjaxOptions

Defined in: [src/types/ajax.d.ts:57](https://github.com/xdan/jodit/blob/main/src/types/ajax.d.ts#L57)

### successStatuses

**successStatuses**: `number`[]

Defined in: [src/types/ajax.d.ts:58](https://github.com/xdan/jodit/blob/main/src/types/ajax.d.ts#L58)

***

### method?

`optional` **method?**: `string`

Defined in: [src/types/ajax.d.ts:64](https://github.com/xdan/jodit/blob/main/src/types/ajax.d.ts#L64)

The HTTP method to use for the request
(e.g. "POST", "GET", "PUT")

***

### url?

`optional` **url?**: `string`

Defined in: [src/types/ajax.d.ts:69](https://github.com/xdan/jodit/blob/main/src/types/ajax.d.ts#L69)

A string containing the URL which the request is sent.

***

### data

**data**: [`DataVariant`](../modules/types.html#datavariant)

Defined in: [src/types/ajax.d.ts:75](https://github.com/xdan/jodit/blob/main/src/types/ajax.d.ts#L75)

Data be sent to the server.
It is converted to a query string, if not already a string. It's appended to the url for GET-requests.

***

### contentType?

`optional` **contentType?**: `string` \| `false`

Defined in: [src/types/ajax.d.ts:81](https://github.com/xdan/jodit/blob/main/src/types/ajax.d.ts#L81)

When sending data to the server, use this content type. Default is "application/x-www-form-urlencoded;
charset=UTF-8", which is fine for most cases

***

### headers?

`optional` **headers?**: [`IDictionary`](../modules/types.html#idictionary)\<`string`\> \| ((`this`) => [`CanPromise`](../modules/types.html#canpromise)\<[`IDictionary`](../modules/types.html#idictionary)\<`string`\> \| `null`\>) \| `null`

Defined in: [src/types/ajax.d.ts:88](https://github.com/xdan/jodit/blob/main/src/types/ajax.d.ts#L88)

An object (or a function which returns an object) of additional header key/value pairs to send along
with requests using the XMLHttpRequest transport. Uses in [FileBrowser](../classes/file_browser.FileBrowser.html)
and [Uploader](../classes/uploader.Uploader.html)

***

### responseType?

`optional` **responseType?**: `XMLHttpRequestResponseType`

Defined in: [src/types/ajax.d.ts:93](https://github.com/xdan/jodit/blob/main/src/types/ajax.d.ts#L93)

***

### withCredentials?

`optional` **withCredentials?**: `boolean`

Defined in: [src/types/ajax.d.ts:98](https://github.com/xdan/jodit/blob/main/src/types/ajax.d.ts#L98)

Enable or disable Access-Control-Allow-Credentials client side. Useful for cross domain requests

***

### queryBuild?

`optional` **queryBuild?**: (`this`, `obj`, `prefix?`) => `string` \| [`FormData`](https://developer.mozilla.org/docs/Web/API/FormData)

Defined in: [src/types/ajax.d.ts:100](https://github.com/xdan/jodit/blob/main/src/types/ajax.d.ts#L100)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `this` | [`IAjax`](./types.IAjax.html)\<`any`\> |
| `obj` | `string` \| [`FormData`](https://developer.mozilla.org/docs/Web/API/FormData) \| [`IDictionary`](../modules/types.html#idictionary)\<`string` \| `object`\> |
| `prefix?` | `string` |

#### Returns

`string` \| [`FormData`](https://developer.mozilla.org/docs/Web/API/FormData)

***

### xhr?

`optional` **xhr?**: () => [`XMLHttpRequest`](https://developer.mozilla.org/docs/Web/API/XMLHttpRequest)

Defined in: [src/types/ajax.d.ts:106](https://github.com/xdan/jodit/blob/main/src/types/ajax.d.ts#L106)

#### Returns

[`XMLHttpRequest`](https://developer.mozilla.org/docs/Web/API/XMLHttpRequest)

***

### onProgress?

`optional` **onProgress?**: (`percentage`) => `void`

Defined in: [src/types/ajax.d.ts:108](https://github.com/xdan/jodit/blob/main/src/types/ajax.d.ts#L108)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `percentage` | `number` |

#### Returns

`void`