colinbdclark / osc.js-examples

Sample code illustrating how to use osc.js in a variety of scenarios.
104 stars 28 forks source link

Unsupported relay() methods in examples? #22

Open davydka opened 2 years ago

davydka commented 2 years ago

Looking through the examples, it seems that .Relay() is used. When debugging and building my app, I went to troubleshoot the Relay() method and the source code indicates that this is an Unsupported, non-API function..

My question/issue is: Should we be presenting unsupported functions in the official examples for OSC.js? If not, we should update this example.

Relay() in examples: https://github.com/colinbdclark/osc.js-examples/blob/b1bc1aa34bb15a5f06ce24a8a46f9c7e7c62cfd8/udp-browser/index.js#L55

Relay() in source code: https://github.com/colinbdclark/osc.js/blob/3bfa3d4489497b04a806298b1f502ffbbdfed2df/src/osc-transports.js#L133

colinbdclark commented 1 year ago

Unsupported, non-API functions probably shouldn't be in the official examples, no. I'll happily take a PR that either provides a reasonable replacement for it in the examples, or a PR to the osc.js repository that addresses the issues in osc.Relay's implementation.