A path proxy object constructor

npm install path-proxy
21 downloads in the last day
134 downloads in the last week
351 downloads in the last month


Given an group of paths (say, from an API schema), you might need to create a set of proxy objects for interacting with those paths. This is the situation I found myself in while working on the Node client for the Heroku API.

Given a set of paths and a base constructor function, path-proxy will create a network of logical proxy objects based on the paths and attach it to the constructor's prototype.


npm install path-proxy --save


var pathProxy = require('path-proxy');

function ApiClient() {}

pathProxy.proxy(ApiClient, [

var client = new ApiClient();"qux").bar();

This may not appear all that useful—they're mostly just empty functions—until you start mucking around with their prototypes:

var BarProxy = pathProxy.pathProxy(ApiClient, "/foo/{id}/bar");
BarProxy.prototype.sayHello = function () {
};"qux").bar().sayHello(); // Logs "hello".

They also have access to a few useful attributes:

var baz ="qux").bar("baz");
baz.params;       // ["qux", "baz"]
baz.pathSegments; // ["foo", "qux", "bar", "baz"]
baz.path;         // "/foo/qux/bar/baz"

And can access the instance of the base constructor they're based off of:

ApiClient.prototype.delete = function (path, callback) {
  var message = + " deleted at " + path;

var client = new ApiClient(); = "Jonathan";

BarProxy.prototype.delete = function (callback) {
  this.base.delete(this.path, callback);

// This:"qux").bar("baz").delete(function (message) {
  // message == "Jonathan deleted at /foo/qux/bar/baz"

// Is equivalent to this:
client.delete("/foo/qux/bar/baz", function (message) {
  // message == "Jonathan deleted at /foo/qux/bar/baz"


path-proxy uses jasmine-node for tests. To run them:

$ npm install
$ npm test
npm loves you