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

api-service

v1.0.8

Published

Simple http service wrapper for client-side JavaScript or Node.js

Downloads

35

Readme

API Service

Simple http service / api wrapper for client-side JavaScript or Node.js. This class helps you creating collections of api-resources with an intuitive and simple api.

Setup

npm install api-service

Simple usage

var Service = require('api-service');

var myApiWrapper = new Service('http://localhost/api')

    // Add users endpoints
    .add('users.list', { method: 'get', route: '/users' })
    .add('users.signup', { method: 'post', route: '/users/signup' })
    .add('users.get.byId', { method: 'get', route: '/users/:id' })
    .add('users.get.byUsername', { method: 'get', route: '/users/username/:username' })

    // Add posts endpoints
    .add('posts.save', { method: 'post', route: '/posts' })
    .add('posts.list', { method: 'get', route: '/posts' })
    .add('posts.get.byId', { method: 'get', route: '/posts/:id' })
    .add('posts.delete', { method: 'delete', route: '/posts/:id' })

    // Add a middleware function that sets authorization header to request
    .use(function (req, next) {
        if (token) {
            req.setRequestHeader('Authorization', token);
        }

        next();
    });

// GET /users
myApiWrapper.users.list()
.then(function (res) {
    var users = res.body;
}, function (res) {
   var error = res.body;
});

// GET /users?q=foo
myApiWrapper.users.list({}, { q: 'foo' })
.then(function (res) {
    var users = res.body;
});


// POST /posts with payload
myApiWrapper.posts.save({ title: 'Foo bar', text: 'Some text...' })
.then(function (res) {
    var success = res.body.success;
}, function (res) {
   var error = res.body;
});

// DELETE /posts/some_id
myApiWrapper.posts.save({ id: 'some_id' })
.then(function (res) {
    var success = res.body.success;
}, function (res) {
   var error = res.body;
});

Service

This class is used to group and organise instances of the api-resource class. Service instances are also event-emitters and they will propagate all events sent by any of their Resource children.

Constructor

  • baseUrl (String) Service base URL (E.g. 'http://www.my-api.com') - without / at the end

Events

The events propagated by this class are documented in the Resource readme.

Methods

  • .add(namespace, [ options ]) Add an endpoint to the service. This will be an instance of Resource pass the options to its constructor
  • .use(middleware) Add a middleware function to the resource. The function will be called on the Resource instance and receive as arguments the XMLHttpRequest request instance and the next function to proceed.

Test

Tests are currently written on server-side only. Run npm install and npm test to test.

Contribution

Contributions are welcome as long as documented and tested.

License

Copyright (c) 2014 Kano Computing Ltd. - Released under the MIT license