auth0 / node-jwks-rsa

A library to retrieve RSA public keys from a JWKS (JSON Web Key Set) endpoint.
MIT License
836 stars 236 forks source link

Document caching #357

Closed sezanzeb closed 1 year ago

sezanzeb commented 1 year ago

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

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

sezanzeb commented 1 year ago

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.