Skip to content

Commit

Permalink
Merge pull request #83 from karelbilek/master
Browse files Browse the repository at this point in the history
Change nil->zero in RefreshInterval comment
  • Loading branch information
MicahParks authored Apr 4, 2023
2 parents b797ba9 + 9a70007 commit e2a23c9
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions options.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ var ErrInvalidHTTPStatusCode = errors.New("invalid HTTP status code")

// Options represents the configuration options for a JWKS.
//
// If RefreshInterval and or RefreshUnknownKID is not nil, then a background goroutine will be launched to refresh the
// If either RefreshInterval is non-zero or RefreshUnknownKID is true, then a background goroutine will be launched to refresh the
// remote JWKS under the specified circumstances.
//
// When using a background refresh goroutine, make sure to use RefreshRateLimit if paired with RefreshUnknownKID. Also
Expand Down Expand Up @@ -54,7 +54,7 @@ type Options struct {
// if a background refresh goroutine is active.
RefreshErrorHandler ErrorHandler

// RefreshInterval is the duration to refresh the JWKS in the background via a new HTTP request. If this is not nil,
// RefreshInterval is the duration to refresh the JWKS in the background via a new HTTP request. If this is not zero,
// then a background goroutine will be used to refresh the JWKS once per the given interval. Make sure to call the
// JWKS.EndBackground method to end this goroutine when it's no longer needed.
RefreshInterval time.Duration
Expand Down

0 comments on commit e2a23c9

Please sign in to comment.