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

jan

v1.1.0

Published

Jan is a simple library for making HTTP requests.

Downloads

24

Readme

Jan NPM Version Bower Version

Join the chat at https://gitter.im/synacorinc/jan

Jan

Jan is a simple library for making HTTP requests.
Issue network calls without dealing with awkward legacy API signatures.

Documentation

Build Status Dependency Status devDependency Status

Deploy


Why Jan?

"AJAX" just isn't a thing anymore.
It's 2014, we're on Web 3.0 or some "living document" version of the web by now.
We don't need to invent names for basic concepts like making HTTP requests.

Ask yourself:

  • Am I using a DOM manipulation library to do networking?
  • Would I consider using a NPM package that both rendered HTML templates and abstracted WebSocket communications?

Application architecture is easier when it isn't tied to monolithic frameworks.
It's time to drop those aging AJAX APIs and get back to the basics of what makes networking simple.

Usage

Basic GET request:

jan.get('/api/foo.json', function(err, res, json) {
	console.log(err, res, json);
});

POST request:

jan.post({
	url : '/api/todos',
	body : 'name=Get%20gas'
}, function(err, res, data) {
	if (err) throw err;
	alert('ToDo created: ' + data.name);
});

Request with all options:

jan({
	method : 'PUT',
	url : 'http://foo.com/bar.json',
	headers : {
		'Content-Type' : 'application/json'
	},
	user : 'bob',
	pass : 'firebird',
	body : JSON.stringify({ key : 'value' })
}, function(err, res) {
	if (err) throw err;
	console.log(res);
});

Plugins / Events

Hook requests with the req event:

// A plugin that adds an API key header to all requests:
jan.on('req', function(e) {
	e.req.headers['x-api-key'] = 'my-super-secure-api-key';
});

Hook responses with the res event:

// A plugin that parses CSV responses
jan.on('res', function(e) {
	if (e.res.headers['content-type']==='text/csv') {
		e.res.data = e.res.csv = e.res.text.split(/\s*\,\s*/g);
	}
});

Instantiation

Via node / browserify:

var jan = require('jan');

Via AMD / requirejs:

define(['jan'], function(jan) {

});

Via globals / script tag:

<script src="jan.js"></script>
<script>
	jan;  // now it's exposed as a "jan" global
</script>

Installation

Installation via Bower: (Recommended)

bower install jan

Manual Download:

  • jan.js - full source with comments, for development
  • jan.min.js - minified, for production

License

BSD


Jan Hankl