Skip to content
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

RENAME login to getCredentials or getAccount ? #33

Closed
ttz642 opened this issue Nov 15, 2019 · 2 comments
Closed

RENAME login to getCredentials or getAccount ? #33

ttz642 opened this issue Nov 15, 2019 · 2 comments
Labels
enhancement New feature or request

Comments

@ttz642
Copy link
Contributor

ttz642 commented Nov 15, 2019

Martin,

The method login is confusing, it isn't actually logging in and does not require any information to LOGIN.

Everybody understands the term login to mean gaining secure access to something by supplying account or other secret information.

Login is really fetching the details about the current session, perhaps it would be better if it were renamed to getCredentials (or getAccount) which more correctly identifies what it is actually doing.

Rather than simply rename and break everybody's code perhaps create a new method getCredentials (or getAccount) (a duplicate of login) and just mark login as:

login has been DEPRECATED and will be removed in the near future, please update your code to use getCredentials (or getAccount)

Perhaps with release 2.0.0, version with LAN access tried and tested ?

--
Steve

@skydiver skydiver added the enhancement New feature or request label Nov 15, 2019
@skydiver
Copy link
Owner

skydiver commented Nov 16, 2019

I agree with you @ttz642

The plan will be:

  1. create getCredentials and keep login as an alias
  2. add getCredentials to docs site
  3. update login docs, saying is deprecated and you should use getCredentials
  4. update openWebSocket method to call getCredentials if needed

I agree on the plan for 2.0, LAN mode should be released and login method can be deleted.

@ttz642
Copy link
Contributor Author

ttz642 commented Nov 25, 2019

Has been added to 1.10.0

@ttz642 ttz642 closed this as completed Nov 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants