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

@gradientedge/axios-client

v1.13.0

Published

Factory for creating an axios client object with built-in default keep-alive/retry mechanism

Downloads

493

Readme

@gradientedge/axios-client

A simple factory function for creating an axios client for use in a nodejs environment. No options are required when calling the getAxiosClient function. In this case, default values will be used for the retry and HttpsAgent config.

Note that no HttpAgent config is provided. We expect all requests to be made via SSL and therefore the only agent we care about is HttpsAgent.

Minimal example:

import { getAxiosClient } from '@gradientedge/axios-client'

/**
 * No options provided, so this will use the default retry and HttpsAgent configuration.
 */
const client = getAxiosClient()

Full config override example:

import { getAxiosClient } from '@gradientedge/axios-client'

const client = getAxiosClient({
  httpsAgent: {
    keepAlive: false,
    timeout: 10000,
    maxSockets: 40,
    scheduling: 'lifo',
    
  },
  retry: {
    delayMs: 100,
    maxRetries: 5,  
  }
})

The client variable above is an AxiosInstance which gives you access to all the standard axios methods and functionality.

Default values via environment variables

The following describes below the environment variables which are read in, and which configuration options they apply to if supplied.

  • REQUEST_TIMEOUT_MS => RequestConfig.httpsAgent.timeout
  • REQUEST_MAX_SOCKETS => RequestConfig.httpsAgent.maxSockets
  • REQUEST_RETRY_MAX_RETRIES => RequestConfig.retry.maxRetries
  • REQUEST_RETRY_DELAY_MS => RequestConfig.retry.delayMs

If no values are specified for the config properties above, then the following fallback default values are used:

  • RequestConfig.httpsAgent.timeout => 5000
  • RequestConfig.httpsAgent.maxSockets => 20
  • RequestConfig.retry.maxRetries => 5
  • RequestConfig.retry.delayMs => 50