Skip to content

docs: clarify getGenericPassword false result - #799

Draft
wanxiankai wants to merge 1 commit into
oblador:masterfrom
wanxiankai:docs/clarify-get-generic-password-result
Draft

wanxiankai wants to merge 1 commit into
oblador:masterfrom
wanxiankai:docs/clarify-get-generic-password-result

Conversation

@wanxiankai

Copy link
Copy Markdown

Summary

Fixes #785 by clarifying what getGenericPassword() returning false means.

  • Updates the getGenericPassword() TSDoc return description to say false means no credentials exist for the requested service
  • Clarifies that Keychain access errors reject the promise instead of being represented by false
  • Adds the same clarification to the basic usage example

Verification

  • git diff --check
  • rg -n 'false.*failure|getGenericPassword.*false|no credentials exist|Keychain access errors|false\ means no credentials' src/index.ts website/docs/usage.md`

Note: this is a documentation/TSDoc-only change. I did not run full lint/typecheck because dependencies are not installed in the local checkout.

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

getGenericPassword result is unclear

1 participant