Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

findPassword - incorrect documentation #87

Closed
Rob--W opened this issue Nov 20, 2017 · 1 comment
Closed

findPassword - incorrect documentation #87

Rob--W opened this issue Nov 20, 2017 · 1 comment
Assignees

Comments

@Rob--W
Copy link

Rob--W commented Nov 20, 2017

From https://github.com/atom/node-keytar/blob/0e1757ae895f63ece9c8641e112b892cbdff34cf/README.md#findpasswordservice :

findPassword(service)

Find a password for the service in the keychain.

service - The string service name.

Yields the string password, or null if an entry for the given service and account was not found.

Which given account? This docs looks like a copy-paste error from the getPassword method.
#36 questioned before why this function was needed, and although it has been closed, the question is still open - what is the purpose of findPassword ?

@shiftkey
Copy link
Contributor

I think this is just a convenience function for situations where you don't need the account value. I'm going to tidy this up in #150. If that's not enough, maybe we can talk about deprecating it.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants