Orc-Ajax

A dead simple AJAX library for making GET or POST requests with no external library dependencies. It's meant for small-scale front end projects that don't require more robust (and larger) comm libraries.

Install

npm i orc-ajax --save

Usage

import OrcAjax from 'orc-ajax';

var url = '/api/pretendthisisreal';

var onSuccess = function (response) {
    console.info('Success!', response);
};

var onError = function (error) {
    console.info('Error.', error);
};

OrcAjax.get(url, onSuccess, onError);

API

OrcAjax.get(url, onSuccess, onError?, shouldLogResponse?)

Performs a GET AJAX request.

Parameters

string url: The url of the API endpoint for the GET request.

function(response) onSuccess: A callback function that is called when the GET request returns a successful response, which is passed into the function.

function(error) onError: Optional. A callback function that is called when the GET request returns an error, which is passed into the function.

boolean shouldLogResponse: Optional. Defaults to false. If true, logs the response from the API in the console.

Example

var url = "/urlgoeshere?something=goesHere";

var onSuccess = function(response) {
    console.info('success!', response);
};

var onError = function(response) {
    console.info('whoops.', response);
};

OrcAjax.get(url, onSuccess, onError); 

OrcAjax.post(url, data, onSuccess, onError?, shouldLogResponse?)

Performs a POST AJAX request.

Parameters

string url: The url of the API endpoint for the POST request.

JSON data: The data to be passed into the POST request.

function(response) onSuccess: A callback function that is called when the POST request returns a successful response, which is passed into the function.

function(error) onError: Optional. A callback function that is called when the POST request returns an error, which is passed into the function.

boolean shouldLogResponse: Optional. Defaults to false. If true, logs the response from the API in the console.

To send a POST, use orcAjax.post().

Example

var data = {
    something: 'or other',
    stuff: 'goes here'
};

var onSuccess = function(response) {
    console.info('success!', response);
};

var onError = function(response) {
    console.info('whoops.', response);
};

orcAjax.post('/urlgoeshere', postData, onSuccess, onError);