From 36ef5b3bd37cb1eadaf4114105015b6223a9484a Mon Sep 17 00:00:00 2001
From: dudaodong <lanliddd.2007@163.com>
Date: Mon, 10 Jul 2023 10:39:55 +0800
Subject: [PATCH] doc: add doc for HasKey

---
 docs/maputil.md       | 49 ++++++++++++++++++++++++++++++++++++++++++-
 docs/maputil_zh-CN.md | 47 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 95 insertions(+), 1 deletion(-)

diff --git a/docs/maputil.md b/docs/maputil.md
index fbcc6f5..7bd7b2c 100644
--- a/docs/maputil.md
+++ b/docs/maputil.md
@@ -43,6 +43,7 @@ import (
 -   [Merge](#Merge)
 -   [Minus](#Minus)
 -   [IsDisjoint](#IsDisjoint)
+-   [HasKey](#HasKey)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -893,7 +894,7 @@ func main() {
 
 ### <span id="IsDisjoint">IsDisjoint</span>
 
-<p>Checks two maps are disjoint if they have no keys in common</p>
+<p>Checks two maps are disjoint if they have no keys in common.</p>
 
 <b>Signature:</b>
 
@@ -937,3 +938,49 @@ func main() {
     // false
 }
 ```
+
+### <span id="HasKey">HasKey</span>
+
+<p>Checks if map has key or not. This function is used to replace the following boilerplate code:</p>
+
+```go
+_, haskey := amap["baz"];
+
+if haskey {
+    fmt.Println("map has key baz")
+}
+```
+
+<b>Signature:</b>
+
+```go
+func HasKey[K comparable, V any](m map[K]V, key K) bool
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/maputil"
+)
+
+func main() {
+    m := map[string]int{
+        "a": 1,
+        "b": 2,
+    }
+
+    result1 := HasKey(m, "a")
+    result2 := HasKey(m, "c")
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+
+    // Output:
+    // true
+    // false
+}
+```
diff --git a/docs/maputil_zh-CN.md b/docs/maputil_zh-CN.md
index dc012c5..f578d78 100644
--- a/docs/maputil_zh-CN.md
+++ b/docs/maputil_zh-CN.md
@@ -43,6 +43,7 @@ import (
 -   [Merge](#Merge)
 -   [Minus](#Minus)
 -   [IsDisjoint](#IsDisjoint)
+-   [HasKey](#HasKey)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -932,3 +933,49 @@ func main() {
     // false
 }
 ```
+
+### <span id="HasKey">HasKey</span>
+
+<p>检查map是否包含某个key。用于代替以下样板代码:</p>
+
+```go
+_, haskey := amap["baz"];
+
+if haskey {
+    fmt.Println("map has key baz")
+}
+```
+
+<b>函数签名:</b>
+
+```go
+func HasKey[K comparable, V any](m map[K]V, key K) bool
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/maputil"
+)
+
+func main() {
+    m := map[string]int{
+        "a": 1,
+        "b": 2,
+    }
+
+    result1 := HasKey(m, "a")
+    result2 := HasKey(m, "c")
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+
+    // Output:
+    // true
+    // false
+}
+```