new BeKeyOf matcher with documentation and unit tests (#590)

onsi · Sep 19, 2022 · fb586b3 · fb586b3
1 parent 647a36b
commit fb586b3
Show file tree

Hide file tree

Showing 4 changed files with 386 additions and 241 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -966,6 +966,14 @@ The difference between the `ContainElements` and `ConsistOf` matchers is that th
 
 succeeds if `ACTUAL` equals one of the elements passed into the matcher. When a single element `ELEMENT` of type `array` or `slice` is passed into the matcher, `BeElementOf` succeeds if `ELEMENT` contains an element that equals `ACTUAL` (reverse of `ContainElement`). `BeElementOf` always uses the `Equal()` matcher under the hood to assert equality.
 
+#### BeKeyOf(m interface{})
+
+```go
+Ω(ACTUAL).Should(BeKeyOf(ELEMENT))
+```
+
+succeeds if `ACTUAL` equals one of the keys of the map passed into the matcher. `BeKeyOf` always uses the `Equal()` matcher under the hood to assert equality with a map key.
+
 #### ConsistOf(element ...interface{})
 
 ```go