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

Document caching #357

Closed
wants to merge 1 commit into from
Closed

Document caching #357

wants to merge 1 commit into from

Conversation

sezanzeb
Copy link
Contributor

@sezanzeb sezanzeb commented Mar 16, 2023

By submitting a PR to this repository, you agree to the terms within the Auth0 Code of Conduct. Please see the contributing guidelines for how to create and submit a high-quality PR for this repo.

Description

Here is an attempt to document at least the parameters I was trying to find more information about today. I'm still uncertain about the meaning of cacheMaxEntries, because understanding those options requires reading through a lot of the code. Please extend my proposal. Actually, I think I still don't understand anything at all. I wish all of the options were documented in the same quality as the other auth0 docs.

Checklist

  • I have added documentation for new/changed functionality in this PR or in auth0.com/docs
  • All active GitHub checks for tests, formatting, and security are passing
  • The correct base branch is being used, if not the default branch

this is just a documentation change, nothing of that is needed

Here is an attempt to document at least the parameters I was trying to find more information about today. I'm still uncertain about the exact meaning of `cacheMaxEntries`, because understanding those options requires reading through a lot of the code. Please extend my proposal
@sezanzeb sezanzeb requested a review from a team as a code owner March 16, 2023 16:09
@sezanzeb
Copy link
Contributor Author

sezanzeb commented Mar 16, 2023

Oh, I have missed https://github.com/auth0/node-jwks-rsa/blob/master/EXAMPLES.md#caching, oops

You can close this if you want. I think I wouldn't haved brushed over the link to that file so quickly if it was DOCS.md instead.

@sezanzeb sezanzeb closed this Mar 16, 2023
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.

None yet

1 participant