Skip to content
/ proxly Public

Easiest way to proxy a list of objects/functions in Javascript

License

Notifications You must be signed in to change notification settings

pshihn/proxly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Proxly

Proxy any list of objects or functions to a single entity.
All common properties and methods are automatically reflected.

  • Objects can be heterogeneous with a shared interface
  • Can proxy a set of functions (sync/async) to a single call
  • Works with Arrays
  • Supports callbacks as arguments
  • Excellent with async/await
  • Tiny in size. Only 444 bytes gzipped

Install

Download the latest from dist folder
or from npm:

npm install --save proxly

Usage/Examples

Proxy Functions

function add(a, b) { return a + b; }
function subtract(a, b) { return a - b; }
async function multiply(a, b) { return a * b; }

(async () => {
  let proxy = proxly(add, subtract, multiply);
  let result = await proxy(4, 2);
  console.log(result); // [6, 2, 8]
})();

Proxy Objects

Objects could be instances of the same class or just any two objects with a common interface.

class Operation {
  constructor(name) {
    this.name = name;
    this.count = 0;
  }
  run(a, b) {
    this.count++;
    if (this.name === 'add') return a + b;
    if (this.name === 'subtract') return a - b;
  }
}
let adder = new Operation('add');
let subtractor = new Operation('subtract');

(async () => {
  let proxy = proxly(adder, subtractor);
  console.log(await proxy.name); // ["add", "subtract"]
  console.log(await proxy.count); // [0, 0]
  console.log(await proxy.run(10, 4)); // [14, 6]
  console.log(await proxy.count); // [1, 1]
})();

Proxy Arrays

Of course it works with arrays

let fruits = ["apple", "banana", "grape"];
let colors = ["red", "yellow", "green"];
(async () => {
  let proxy = proxly(fruits, colors);
  console.log(await proxy[1]); // ["banana", "yellow"]
  console.log(await proxy.length); // [3, 3]
  proxy.push('orange');
  console.log(await proxy.length); // [4, 4]
  console.log(fruits); // ["apple", "banana", "grape", "orange"]
  console.log(colors); // ["red", "yellow", "green", "orange"]
})();

Callbacks

If a callback is passed into a proxied set of functions (or a method in a proxied set of objects), it is called back sequentially in the order the proxy was defined.

function add(a, b, cb) {
  cb(a + b);
}
function sub(a, b, cb) {
  setTimeout(() => {
    cb(a - b);
  }, 1000);
}
(async () => {
  let cb = (result) => {
    console.log("result", result);
  };
  let proxy = proxly(add, sub);
  proxy(6, 4, cb);
})();

Output:

result 10
result 2

Examples

See the examples folder

License

MIT License (c) Preet Shihn