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

swapijs

v1.0.0

Published

Javascript client for [SWAPI](http://swapi.co/) (a Star Wars API).

Downloads

3

Readme

swapijs

Javascript client for SWAPI (a Star Wars API).

Resources

swapi.films
swapi.people
swapi.planets
swapi.species
swapi.vehicles
swapi.starships

Each function returns a new 'Resource' - an interface for fetching different types of data from the API.

var peopleResource = swapi.people();

Fetching data

A resource has a single main method: get. It accepts two optional parameters: an id, and a callback function.

peopleResource.get('2', callback);

Providing an id will fetch a single resource, ommitting it will return multiple.

peopleResource.get(callback);

All data returned from list end points on the SWAPI API is paginated. Calling resource.get without the id parameter will fetch the first page of data for that resource. Subsequent calls will return each following page in turn, until the resource is depleted.

Resources cache all data returned by the API by url.

Error first

Callbacks follow the error first callback paradigm.

peopleResource.get(function(error, response) {
    if (error) {
        console.log(error);
        return;
    }
    console.log(response);
});

### Events

You can also listen for events on resources:

The 'added' event is triggered when the resource has successfully fetched new data. The callback recieves the array of results, and the response dictionary.

peopleResource.on('added', function(added, responsee) {
	
});

The 'depleted' event is triggered when a response is returned that doesn't contain a URL for fetching further data from that resource.

peopleResource.on('depleted', function() {
	
});

The 'empty' event is triggered whenever get is called on a depleted resource.

peopleResource.on('empty', function() {
	
});