Skip to content

Latest commit

 

History

History
407 lines (290 loc) · 10.9 KB

README.md

File metadata and controls

407 lines (290 loc) · 10.9 KB

Ajax

Easy module for async requests in a native JavaScript.

Installation

You can install this package via NPM or Yarn

npm i --save-dev @codexteam/ajax
yarn add -D @codexteam/ajax

Require package on your script page.

const ajax = require('@codexteam/ajax');

Also you can get this module from CDN or download a bundle file and use it locally.

Usage

There are a few public functions available to be used by user. All of them return Promise.

  • ajax.request()
  • ajax.post()
  • ajax.get()
  • ajax.transport()

Params

List of params, their types, descriptions and examples.

url string (required)

Target page URL.

Example

/user/22, /getPage, /saveArticle

method string

Used in ajax.request() function only

Request method.

GET, POST

Read more about available request methods methods on the page at developer.mozilla.org.

data object|FormData|string|HTMLElement

For ajax.request() use should encode data and add headers by yourself

To avoid any unexpected troubles ajax.request() will not encode passed data by itself.

Example
const params = {
  url: '/joinSurvey',
  method: 'POST',
  data: JSON.stringify({user: 22}),
  headers: {
    'content-type': 'application/json; charset=utf-8'
  }
};

ajax.request(params)
  .then(successCallback)
  .catch(errorCallback);
const params = {
  url: '/sendForm',
  method: 'POST',
  data: new FormData(document.getElementById('my-form'))
};

ajax.request(params)
  .then(successCallback)
  .catch(errorCallback);

For ajax.get() you can pass object data

Data will be encoded automatically.

const params = {
  url: '/getUserData',
  data: {
    user: 22
  }
};

ajax.get(params)
  .then(successCallback)
  .catch(errorCallback);

is the same as

const params = {
  url: '/getUserData?user=22'
};

ajax.get(params)
  .then(successCallback)
  .catch(errorCallback);

For ajax.post() you can pass data as object, FormData or HTMLElement

For ajax.transport() should pass object data if it is necessary

You can send additional data with files.

const params = {
  url: '/uploadImage',
  accept: 'image/*',
  data: {
    visible: true,
    caption: 'Amazing pic'
  },
  fieldName: 'image'
};

ajax.transport(params)
  .then(successCallback)
  .catch(errorCallback);

type string

Used in ajax.post() function only

Specify the content type of data to be encoded (by ajax module) and sent.

You can get value for this param from ajax.contentType object. Data will be encoded that way.

ajax.contentType value
JSON application/json; charset=utf-8
URLENCODED application/x-www-form-urlencoded; charset=utf-8
FORM multipart/form-data
Example
const params = {
  // ...
  
  type: ajax.contentType.JSON 
  // type: ajax.contentType.URLENCODED
  // type: ajax.contentType.FORM
};

headers object

Object of custom headers which will be added to request.

Example
headers = {
  'authorization': 'Bearer eyJhbGciJ9...TJVA95OrM7h7HgQ',
  // ...
}

progress function

Almost all requests have responses. To show a correct progress for a call we need to combine a request progress (uploading) and a response progress (downloading). This ajax module uses one progress callback for it.

Example
/**
 * @param {number} percentage - progress value from 0 to 100 
 */
var progressCallback = function progressCallback(percentage) {  
    document.title = `${percentage}%`;
};

Check out ratio param to show progress more accurate.

ratio number

Used with progress param

Value should be in the 0-100 interval.

If you know that some requests may take more time than their responses or vice versa, you can set up a ratio param and define a boundary between them on the progress bar.

For example if you want to show progress for a file uploading process, you know that uploading will take a much more time than downloading response, then pass bigger ratio (~95). When you want to download big file — use smaller ratio (~5).

accept string

Used in ajax.transport() function only

String of available types of files to be chosen by user.

Example

*/* — any files (default)

image/* — only images

image/png, image/jpg, image/bmp — restrict accepted types

Read more about MIME-types on the page at developer.mozilla.org.

multiple boolean

Used in ajax.transport() function only

false by default. User can choose only one file.

If you want to allow user choose more than a one file to be uploaded, then pass a true value.

fieldName string

Used in ajax.transport() function only

Name of data field with the file or array of files.

files by default.

ajax.request()

Main function for all requests.

param type default value description
url string (required) Request URL
method string 'GET' Request method
data FormData or string null Data to be sent
headers object null Custom headers object
progress function (percentage) => {} Progress callback
ratio number 90 Max % of bar for uploading progress 
const data = {
  user: 22
};

const params = {
  url: '/joinSurvey',
  method: 'POST',
  data: JSON.stringify(data),
  headers: {
    'content-type': 'application/json; charset=utf-8'
  }
};

ajax.request(params)
  .then(successCallback)
  .catch(errorCallback);

ajax.get()

Wrapper for a GET request over an ajax.request() function.

param type default value description
url string (required) Request URL
data object null Data to be sent
headers object null Custom headers object
progress function (percentage) => {} Progress callback
ratio number 90 Max % of bar for uploading progress

Example

const params = {
  url: '/getUserData',
  data: {
    user: 22
  }
};

ajax.get(params)
  .then(successCallback)
  .catch(errorCallback);

ajax.post()

Wrapper for a POST request over an ajax.request() function.

param type default value description
url string (required) Request URL
data object, FormData or HTMLElement null Data to be sent
type string 'application/json; charset=utf-8' Header from ajax.contentType object
headers object null Custom headers object
progress function (percentage) => {} Progress callback
ratio number 90 Max % of bar for uploading progress

Example

Simple POST request

const params = {
  url: '/saveArticle',
  data: {
    title: 'Awesome article',
    text: 'will be written later',
    isPublished: false
  },
  
  /** Choose the content type you need */
  type: ajax.contentType.JSON 
  // type: ajax.contentType.URLENCODED
  // type: ajax.contentType.FORM
};

ajax.post(params)
  .then(successCallback)
  .catch(errorCallback);

Example

To send any form you can pass form HTMLElement as a data to ajax.post().

<form id="form-element">
    <input type="text" name="firstName" placeholder="First name">
    <input type="text" name="lastName" placeholder="Last name">
    <input type="file" name="profileImage" accept="image/*">
    <button onclick="event.preventDefault(); sendForm()">Send form</button>
</form>

<script>
function sendForm() {
  var form = document.getElementById('form-element');
  
  var requestParams = {
    url:'/addUser',
    data: form
  };
  
  ajax.post(requestParams)
    .then(successCallback)
    .catch(errorCallback);
} 
</script>

ajax.transport()

This is a function for uploading files from client.

User will be asked to choose a file (or multiple) to be uploaded. Then FormData object will be sent to the server via ajax.post() function.

param type default value description
url string (required) Request URL
data object null Additional data to be sent
accept string null Mime-types of accepted files
multiple boolean false Let user choose more than one file
fieldName string 'files' Name of field in form with files
headers object null Custom headers object
progress function (percentage) => {} Progress callback
ratio number 90 Max % of bar for uploading progress

Example

const params = {
  url: '/uploadImage',
  accept: 'image/*',
  progress: function (percentage) {
    document.title = `${percentage}%`;
  },
  ratio: 95,
  fieldName: 'image'
};

ajax.transport(params)
  .then(successCallback)
  .catch(errorCallback);

Example

One simple button for uploading files.

<button onclick='ajax.transport({url: "/uploadFiles"}).then(successCallback).catch(errorCallback)'>Upload file<button>