Add doc of behavior when replaceFunc returns an error, resolves #5

motoki317 · Nov 9, 2023 · bad4ef1 · bad4ef1
1 parent 89a9b42
commit bad4ef1
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/cache.go b/cache.go
@@ -7,6 +7,9 @@ import (
 	"time"
 )
 
+// replaceFunc is automatically called when value is not present or expired.
+// The cache makes sure that replaceFunc is always called once for the same key at the same time.
+// When replaceFunc returns an error, value will not be cached.
 type replaceFunc[K comparable, V any] func(ctx context.Context, key K) (V, error)
 
 // NewMust is similar to New, but panics on error.