path-proxy

path-proxy

path-proxy is based on my work on the Node client for the Heroku API. Its purpose is to, given a base constructor function and an array of paths (most likely for an API), build a network of proxy object constructors on top of that base constructor.

Example:

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

function Client () {
}

Client.prototype.sayHello = function () {
  return "hello";
}

pathProxy.proxy(Client, [
  "/foo",
  "/foo/{id}/bar",
  "/foo/{id}/bar/{id}/baz"
]);

var client = new Client(),
    baz    = client.foo("a").bar("b").baz();

// `baz` is a proxy object for "/foo/a/bar/b/baz". It also has access to
// `client` through its `base` parameter.
baz.params;          // ["a", "b"]
baz.path;            // "/foo/a/bar/b/baz"
baz.base.sayHello(); // "hello"

Proxy constructor functions can also be fetched individually:

var qux = pathProxy.pathProxy(Client, "/qux");

qux.prototype.foo = function () {
  return "foo";
}

client.qux().foo(); // "foo"

Note that this project is still extremely unstable. As in, don't be surprised at awful things like force-pushes to master.