https://github.com/jclem/path-proxy
a proxy object constructor for working with API schemas
https://github.com/jclem/path-proxy
Last synced: about 1 year ago
JSON representation
a proxy object constructor for working with API schemas
- Host: GitHub
- URL: https://github.com/jclem/path-proxy
- Owner: jclem
- Created: 2013-12-12T09:35:19.000Z (over 12 years ago)
- Default Branch: development
- Last Pushed: 2018-10-08T14:15:32.000Z (over 7 years ago)
- Last Synced: 2025-04-10T17:31:12.091Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://npmjs.org/package/path-proxy
- Size: 207 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# path-proxy
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][heroku_client].
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.
## Install
```sh
npm install path-proxy --save
```
## Usage
```javascript
var pathProxy = require('path-proxy');
function ApiClient() {}
pathProxy.proxy(ApiClient, [
"/foo",
"/foo/{id}/bar"
]);
var client = new ApiClient();
client.foo("qux").bar();
```
This may not appear all that useful—they're mostly just empty functions—until you
start mucking around with their prototypes:
```javascript
var BarProxy = pathProxy.pathProxy(ApiClient, "/foo/{id}/bar");
BarProxy.prototype.sayHello = function () {
console.log("hello");
};
client.foo("qux").bar().sayHello(); // Logs "hello".
```
They also have access to a few useful attributes:
```javascript
var baz = client.foo("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:
```javascript
ApiClient.prototype.delete = function (path, callback) {
var message = this.name + " deleted at " + path;
callback(message);
};
var client = new ApiClient();
client.name = "Jonathan";
BarProxy.prototype.delete = function (callback) {
this.base.delete(this.path, callback);
};
// This:
client.foo("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"
});
```
## Tests
path-proxy uses jasmine-node for tests. To run them:
```sh
$ npm install
$ npm test
```
## Thanks, Heroku
While I created and maintain this project, it was done while I was an employee
of [Heroku][heroku] on the Human Interfaces Team, and they were kind enough to
allow me to open source the work. Heroku is awesome.
[heroku]: https://www.heroku.com/home
[heroku_client]: https://github.com/heroku/node-heroku-client