AjaxHelper

A static utility class that simplifies Ajax requests using the browser's Fetch API. It provides convenience methods for common HTTP verbs (GET, POST) and returns standard Response promises. Global defaults can be set via DEFAULT_FETCH_OPTIONS.

const response = await AjaxHelper.get('some-url');
const data     = await response.json();

Uploading a file to the server via FormData:

const formData = new FormData();
formData.append('file', 'fileNameToUpload');
AjaxHelper.post('file-upload-url', formData).then(response => {
    // process request response here
});

Useful functions

Function	Description
get	Perform a `GET` request
post	Perform a `POST` request
fetch	Perform a request with any HTTP method

Properties

Properties are getters/setters or publicly accessible variables on this class

DEFAULT_FETCH_OPTIONS : FetchOptions

static

Sets default options for AjaxHelper#fetch() calls. Please see FetchOptions and fetch API for details.

// default content-type for all requests will be "application/json"
AjaxHelper.DEFAULT_FETCH_OPTIONS = {
    headers : {
        'content-type' : 'application/json'
    }
};

Functions

Functions are methods available for calling on the class

fetch( url, options )
: Promise

ASYNC

static

Fetch the specified resource using the fetch API.
get( url, options )
: Promise

ASYNC

static

Make a request (using GET) to the specified url.
mockUrl( url, response )

static

Registers the passed URL to return the passed mocked up Fetch Response object to the AjaxHelper's promise resolve function.
post( url, payload, options )
: Promise

ASYNC

static

POST data to the specified URL.

Type definitions

FetchOptions
Options for the requests. Please see fetch API for details

To set default values for the options please use DEFAULT_FETCH_OPTIONS property:
```
// enable passing parameters in request body by default
AjaxHelper.DEFAULT_FETCH_OPTIONS = { addQueryParamsToBody : true };
```
Properties
- method : 'GET'/'POST'/'PUT'/'PATCH'/'DELETE'
  
  The request method, e.g., GET, POST
- queryParams : Object
  
  A key-value pair Object containing the params to add to the query string
- headers : Object
  
  Any headers you want to add to your request, contained within a Headers object or an object literal with ByteString values
- body : Object
  
  Any body that you want to add to your request: this can be a Blob, BufferSource, FormData, URLSearchParams, or USVString object. Note that a request using the GET or HEAD method cannot have a body.
- addQueryParamsToBody : Booleanfalse
  Indicates whether queryParams should be passed in the request body. Adding them to the body applies for application/x-www-form-urlencoded and multipart/form-data content types only, so make sure to pass corresponding Content-Type header to headers.
  
  When the argument is true and:
  
  if application/x-www-form-urlencoded content-type header is passed the method will make a URLSearchParams instance with queryParams and set it as the request body. And if body already has a URLSearchParams instance provided the parameters will be set there.
  
  if multipart/form-data content-type header is passed the method will make a FormData instance with queryParams and set it as the request body. And if body already has a FormData instance provided the parameters will be set there.
  
  Otherwise, queryParams are added to the query string.
- mode : 'cors'/'no-cors'/'same-origin'
  
  The mode you want to use for the request, e.g., 'cors', 'no-cors', or 'same-origin'.
- credentials : 'omit'/'same-origin'/'include'
  
  The request credentials you want to use for the request: 'omit', 'same-origin', or 'include'. To automatically send cookies for the current domain, this option must be provided
- parseJson : Boolean
  
  Specify true to parses the response and attach the resulting object to the Response object as parsedJson
- abortController : AbortController
  
  Provide abort controller to be able to cancel fetch

Source path

Core/helper/AjaxHelper.js

Inheritance tree1

AjaxHelper

AjaxHelper

Useful functions

See also

Properties

Functions

Type definitions

Properties

Source path

Inheritance tree1

Contents