npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ajax2

v0.0.23

Published

A simple ajax library with optional case converter

Downloads

402

Readme

ajax2

A simple ajax library with optional case converter

Installation

Using npm:

npm i --save ajax2

Basic usage

To make a request, use the following structure:

import ajax2 from 'ajax2'

ajax2.get('/path/to/resource')
    .then(function(response){
        // response will be an object if json was returned or text.
    })
    .catch(function(err){
        console.log({
            statusCode: err.statusCode, // e.g. 404
            statusText: err.statusText, // e.g. Not found
            response: err.response // Whatever the body was. Json will be parsed and an object returned
        });
    });

# Adding data to the request
ajax2.post('/whatever', {hereGoesTheData: ''})

Supported methods are get, post, put, patch, delete.

All calls will return a Promise, which you can use with await.

Case conversion

Optionally, ajax2 will convert request data from camelCase to snake_case, for usage with Python or Ruby. Conversely responses can be converted from snake_case to camelCase.

Note that only the keys will be converted. Example:

ajax2.post('/whatever', {exampleKey: 'exampleValue'})

will create a request with the following json:

{"example_key": "exampleValue"}

This is intended to preserve user input.

To enable this, call ajax2._configure...

Changing configuration

To change configuration, use ajax2._configure.

ajax2._configure({
    convertRequest: null, // 'snakeCase', 'camelCase', or null
    convertResponse: null, // 'snakeCase', 'camelCase', or null
    headers: {}, // A dictionary with headers to send with all requests
    addRequestedWith: true, // Adds 'X-Requested-With' to headers
    credentials: 'same-origin', // 'same-origin', 'include', or null
    baseUrl: null // Whatever url to prepend all requests urls with
});

You can override configuration for a particular request by passing configuration to the request method.

ajax2.post('/whatever', {hereGoesTheData: ''}, {credentials: null})

NB: It is not necessary to specify a Content-Type header as this will be set to application/json if there is data (and it is not a GET request).