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

tidy up README #150

Merged
shiftkey merged 2 commits into from
Jan 21, 2019
Merged

tidy up README #150

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cb9ad5
drop mention of account
shiftkey Jan 21, 2019
338d1e1
reorder this bit to emphasize findCredentials
shiftkey Jan 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,18 +68,19 @@ Delete the stored password for the `service` and `account`.

Yields `true` if a password was deleted, or `false` if an entry with the given service and account was not found.

### findPassword(service)
### findCredentials(service)

Find a password for the `service` in the keychain.
Find all accounts and 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.
Yields an array of `{ account: 'foo', password: 'bar' }`.

### findCredentials(service)
### findPassword(service)

Find all accounts and password for the `service` in the keychain.
Find a password for the `service` in the keychain. This is ideal for scenarios where an `account` is not required.

`service` - The string service name.

Yields an array of `{ account: 'foo', password: 'bar' }`.
Yields the string password, or `null` if an entry for the given service was not found.