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

Better documentation for Credentials.expiryWindow #4258

Open
rawpixel-vincent opened this issue Nov 2, 2022 · 1 comment
Open

Better documentation for Credentials.expiryWindow #4258

rawpixel-vincent opened this issue Nov 2, 2022 · 1 comment
Assignees
Labels
documentation This is a problem with documentation. p2 This is a standard priority issue

Comments

@rawpixel-vincent
Copy link

Describe the issue

Link to docs: http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Credentials.html

The entry on expiryWindow just shows the default value of 15. From reading the source code, I think this means 15 seconds. The description should probably say something like "the amount of time (in seconds) before the expireTime that the credentials is considered expired."

Links

http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Credentials.html

@rawpixel-vincent rawpixel-vincent added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Nov 2, 2022
@ajredniwja ajredniwja self-assigned this Nov 11, 2022
@ajredniwja
Copy link
Member

Hi @rawpixel-vincent thanks for opening this issue, looking at

* @return [Integer] the number of seconds before {expireTime} during which
it seems like it is in seconds.

@ajredniwja ajredniwja added p2 This is a standard priority issue and removed needs-triage This issue or PR still needs to be triaged. labels Nov 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. p2 This is a standard priority issue
Projects
None yet
Development

No branches or pull requests

2 participants