Skip to content

Commit 4dd663f

Browse files
committed
Document return values
1 parent ff2962f commit 4dd663f

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ map.size // => 1
2828
### Methods
2929

3030
- `get(key)` - Retrieve the Set of values stored under a key or the empty Set if the key does not exist.
31-
- `set(key, value)` - Add a value to the key's set without removing previous values.
31+
- `set(key, value)` - Add a value to the key's set without removing previous values. Returns the map so `set` can be chained.
3232
- `has(key)` - Returns true if a value is stored under the key.
33-
- `delete(key)` - Remove key and all of key's values.
34-
- `delete(key, value)` - Remove a value from the key's set.
35-
- `drain(value)` - Remove a value from all keys that reference it.
33+
- `delete(key)` - Remove key and all of key's values. Returns true if the key existed.
34+
- `delete(key, value)` - Remove a value from the key's set. Returns true if the key and value existed.
35+
- `drain(value)` - Remove a value from all keys that reference it. Returns an array of keys removed.
3636
- `clear()` - Remove all keys and values to empty the map.
3737
- `keys()` - An iterator of map keys.
3838
- `values()` - An iterator of Sets of values for all keys.

0 commit comments

Comments
 (0)