add docs

zekroTJA · Mar 25, 2023 · fb90959 · fb90959
1 parent 78c8426
commit fb90959
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/timedmap.go b/timedmap.go
@@ -57,6 +57,12 @@ func New(cleanupTickTime time.Duration, tickerChan ...<-chan time.Time) *TimedMa
 	return newTimedMap(make(map[keyWrap]*element), cleanupTickTime, tickerChan)
 }
 
+// FromMap creates a new TimedMap containing the given
+// keys and values from the passed map m. All key-value
+// pairs will be assigned the given expiration.
+//
+// Returns ErrValueNoMap if the given value for m is
+// not of type map.
 func FromMap(
 	m interface{},
 	expiration time.Duration,