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

switchless-api-wrapper

v1.1.4

Published

As the name suggests that is a simple api wrapper. Wrap your API backend build with switchless and others can make API requests in a simple manner.

Downloads

8

Readme

API wrapper

As the name suggests that is a simple api wrapper. Wrap your API backend build with switchless and others can make API requests in a simple manner.

The purpose of this wrapper is to make your code more readable.

Without switchless API wrapper

var url =api_endpoint+'/invoices?secret='+secret+'&filing='+results.getGstr2aFiling.id; 
console.log(url);
var options = {
  'method': 'GET',
  'url': url,
};
request(options, function (error, response) { 
  if (error) callback(error);
  var body = JSON.parse(response.body);
  callback(error,body);
});

More lines of code describing how to make the API request. It takes your attention off the business logic that you are working on. Want to add another query parameter, you need to write +'&query_param='+query

With switchless API wrapper

In the previous case, you need to think about implementation logic while thinking about business logic. Switchless is all about minimising switching. This package hides the implementation logic so that you can stay focused on business logic.

Initial setup

var SwitchlessAPIWrapper = require('switchless-api-wrapper');
var settings = {
	base_url:'https://app.mralbert.in/apis/v1',
	auth:{
		type:'secret_key',
		key:'secret',
		value:'the_big_secret_key',
		via:'query_params'
	},
	headers:{
		// headers that you want to include in all requests
	},
	body:{
		// body params that you want to include in all requests. (Does not apply to GET requests)
	},
	query:{
		// query params that you want to include in all requests
	},
	timeout:60000, // in milli seconds
	parse_body:true, // defaults to true
}
var api = new SwitchlessAPIWrapper(options);

typical usage

var options={
	url:'/invoices',
	method:'GET',
	query:{
		filing:results.getGstr2aFiling.id,
		limit:100
	},
}

api.request(options,function(err,response){
	callback(err,response.body) // response body is already converted to JSON
})

Supports multiple authentication strategies (coming soon)

For now the package supports master secret key specified via query params.

settings

  • query
  • headers
  • body
  • parse_body
  • base_url
  • timeout