New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Public API design for 4.0 #731

Open
sualko opened this Issue Sep 25, 2018 · 1 comment

Comments

Projects
None yet
2 participants
@sualko
Copy link
Member

sualko commented Sep 25, 2018

The current public API is mainly available directly under the jsxc namespace and can be called in any order. This means people can call jsxc.start before they call jsxc.init which is obviously a bad idea. A more chain-based approach could help here. This means jsxc.init would return the API which can only be called after the init method. This could also be handy in a multi-account setup, where you could get account specific APIs after calling some jsxc.getAccount method. What are you thoughts?

Current

jsxc.init({...});
jsxc.start();

Proposal

jsxc.init({...}).start();

@sualko sualko added the discussion label Sep 25, 2018

@jsxc jsxc deleted a comment from jsxc-bot Sep 25, 2018

@mmoqui

This comment has been minimized.

Copy link
Contributor

mmoqui commented Oct 25, 2018

+1 for the proposal.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment