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

rest-promise

v1.5.1

Published

Promise wrapper arround request library with rest style builder methods

Downloads

9

Readme

#Rest promise class ES6 Rest class for node (not browser), wrapper arround request library with basic and more common used functionalities ##Example usage

var RestPromise = require("rest-promise");
var url = "http://example.com/account/:accountId/otherArg/:myOtherArg";
var resource = new RestPromise(url);
var restPromise = resource
	.pathParams({accountId: 1, myOtherArg: "argValue"})	//params that will be replaced in url insted of placeholders
		.json()		//data will be sent and interpreted as json
		.requestData({var1: "value1", var2: "value2"}) 	//data that will be sent in query string or body, depending of method
		.log()				//request will be logged to console
		.timeout(10000) 	//requst will be timed out after 10 seconds (10.000 ms)
		.get();				//performs get method can be one of, .get(), post(), put(), delete() 

restPromise.then((responseBody)=>{
	console.log(responseBody);
}).catch(RestPromise.logAndRethrow);

Note: you dont have to set all params. In effect, invoking get(), post(), put() etc is the only thing you have to invoke ###RestPromise can be reused, for example

var RestPromise = require("rest-promise");
var url = "http://example.com/account/:accountId";
var resource = new RestPromise(url, {accountId: 1}); //path params aplied immidiately and preserved for future use. 
													  //If you use .pathParams() method after this it wont have anny effect

resource.get().then((account)=>{
	account.touchedAt = new Date();
	return account;
}).then(resource.post).then(()=>{ 					//same resource will be resused
	console.log("Account touch timestamp updated");
}); 							

###Heders and cookies Headers and cookies can be added following same builder method:

var RestPromise = require("rest-promise");
var url = "http://example.com/account/:myPathParam";
var resource = new RestPromise(url, {myPathParam: "value"});
resource.header("User-Agent", "My app").header("Accept", "text/plain").header("Content-Type", "application/json");
resource.cookie("myCookie1", "myValueCookie1").cookie("myCookie2", "myCookieValue2");
resource.get((page)=>{
	console.log(page);
});

Note: after every request you must rebuild parameters/headers again.

###Basic authentication Can be added via basicAuth builder method:

var RestPromise = require("rest-promise");
var url = "http://example.com/account/:myPathParam";
var resource = new RestPromise(url, {myPathParam: "value"});
resource.basicAuth("someUser", "somePass").get((page)=>console.log(page));

Note: auth header is saved in rest promise instance, so as long you are using same instance you dont need to set it again.

###Cathcing errors RestPromise class ships with one static method called 'logAndRethrow' which can be used as utility when catching errors. It simply logs error stack trace to console.error and then rethrows same error. sample usage:

var RestPromise = require("rest-promise");
var resource = new RestPromise(url);
resource.asJson().get().then((result)=>{
	console.log(result);
}).catch(RestPromise.logAndRethrow);