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

acejax

v2.0.1

Published

Zero dependency, Promise based HTTP request library for Node.js

Downloads

21

Readme

acejax

CircleCI XO code style code style: prettier install size Downloads

Zero dependency, Promise based HTTP request library for Node.js

Install

$ npm install --save acejax

Usage

const acejax = require('acejax');

const myFunction = async () => {
    try {
        const result = await acejax('https://github.com/acestojanoski/acejax');
        console.log(result.body);
        // output: <!doctype html>...
    } catch(error) {
        console.error(error);
        // output: { AcejaxError: Unauthorized...
    }
};

myFunction();
const acejax = require('acejax');

const myFunction = async () => {
    try {
        const result = await acejax('https://some-api-endpoint', { json: true });

        console.log(result.body);
        /* output (json parsed):
        *   {
        *       id: 1,
        *       name: 'some name', ...
        *   }
        */
    } catch(error) {
        console.error(error);
        // output: { AcejaxError: Forbidden...
    }
};

myFunction();

API

acejax(url, acejaxOptions?)

Returns: Promise

Both resolved and rejected Promise will have the same format: Response

url

Type: string

The request URL.

acejaxOptions

Type: object

The https.request() options.

The method is GET by default.

json

Type: boolean

Default: false

If this is set to true, the acejax library will use the JSON.parse() function to parse the response body.

body

Type: string | object | Buffer

The request body.

form

Type: object | string

If this option is provided the Content-Type header will be set to application/x-www-form-urlencoded.

If it is an object, the object will be converted to string using new URLSearchParams(object).toString().

acejax.get(url, acejaxOptions?)

acejax.delete(url, acejaxOptions?)

acejax.post(url, acejaxOptions?)

acejax.put(url, acejaxOptions?)

acejax.patch(url, acejaxOptions?)

Response

Type: object

On promise rejection, it will be an instance of the custom error class AcejaxError. The name of the error will be set to AcejaxError, and the error message will be the statusMessage of the response. Additionally, it contains the standard response properties.

statusCode

Type: number

The response status code.

statusMessage

Type: string

The response status message.

headers

Type: object

The response headers.

rawHeaders

Type: Array<string>

The response rawHeaders

httpVersion

Type: string

The response http version.

acejaxOptions

Type: object

It will return back the acejaxOptions.

url

Type: string

It will return back the request url.

body

Type: string | object

The body of the response.

LICENSE

MIT