docs: Added Set::values() documentation

rudashi · Sep 26, 2024 · 2994a95 · 2994a95
1 parent 7e206cf
commit 2994a95
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/docs/Set.md b/docs/Set.md
@@ -11,6 +11,7 @@ The Set object holds only unique values of any type.
 - [`Set::entries()`](#setentries)
 - [`Set::forEach()`](#setforeach)
 - [`Set::has()`](#sethas)
+- [`Set::values()`](#setvalues)
 - [`Set::size`](#setsize)
 
 ## Constructor
@@ -127,6 +128,23 @@ $set->has(6);
 // false
 ```
 
+### Set::values()
+
+The `values()` method returns a new `SetIterator` instance that contain the values of each element of the Set.
+
+```php
+$set = new Set(['foo', 'bar']);
+
+$iterator = $set->values();
+// [object SetIterator]
+
+$iterator->current();
+// 'foo'
+
+$iterator->next();
+// 'bar'
+```
+
 ## Properties
 
 ### Set::size