Please document cacheMaxAge and jwksRequestsPerMinute

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

Please document cacheMaxAge and jwksRequestsPerMinute #324

Closed Aaronius closed 2 years ago

Aaronius commented 2 years ago

Describe the problem you'd like to have solved

The cacheMaxAge and jwksRequestsPerMinute options could be better documented.

Describe the ideal solution

Please document cacheMaxAge and jwksRequestsPerMinute under JwksClient Options. For cacheMaxAge, please explicitly define what unit the value is in (milliseconds?).

Alternatives and current work-arounds

Additional information, if any

adamjmcgrath commented 2 years ago

Thanks for raising this @Aaronius - raised #327