From f198711d1cb63e01b5ee4f3031883a12f45523c4 Mon Sep 17 00:00:00 2001 From: dudaodong Date: Thu, 7 Sep 2023 16:03:08 +0800 Subject: [PATCH] doc: add doc for new functions --- docs/api/packages/validator.md | 308 +++++++++++++++++++++++++++- docs/en/api/packages/validator.md | 306 +++++++++++++++++++++++++++ validator/validator_example_test.go | 60 ++++++ 3 files changed, 673 insertions(+), 1 deletion(-) diff --git a/docs/api/packages/validator.md b/docs/api/packages/validator.md index 83470ba..822b3eb 100644 --- a/docs/api/packages/validator.md +++ b/docs/api/packages/validator.md @@ -55,6 +55,15 @@ import ( - [IsZeroValue](#IsZeroValue) - [IsGBK](#IsGBK) - [IsPrintable](#IsPrintable) +- [IsBin](#IsBin) +- [IsHex](#IsHex) +- [IsBase64URL](#IsBase64URL) +- [IsJWT](#IsJWT) +- [IsVisa](#IsVisa) +- [IsMasterCard](#IsMasterCard) +- [IsAmericanExpress](#IsAmericanExpress) +- [IsUnionPay](#IsUnionPay) +- [IsChinaUnionPay](#IsChinaUnionPay)
@@ -1190,4 +1199,301 @@ func main() { // true // false } -``` \ No newline at end of file +``` + +### IsBin + +

检查字符串是否是有效的二进制数。

+ +函数签名: + +```go +func IsBin(v string) bool +``` + +示例: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsBin("0101") + result2 := validator.IsBin("0b1101") + result3 := validator.IsBin("b1101") + result4 := validator.IsBin("1201") + + fmt.Println(result1) + fmt.Println(result2) + fmt.Println(result3) + fmt.Println(result4) + + // Output: + // true + // true + // false + // false +} +``` + +### IsHex + +

检查字符串是否是有效的十六进制数。

+ +函数签名: + +```go +func IsHex(v string) bool +``` + +示例: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsHex("0xabcde") + result2 := validator.IsHex("0XABCDE") + result3 := validator.IsHex("cdfeg") + result4 := validator.IsHex("0xcdfeg") + + fmt.Println(result1) + fmt.Println(result2) + fmt.Println(result3) + fmt.Println(result4) + + // Output: + // true + // true + // false + // false +} +``` + +### IsBase64URL + +

检查字符串是否是有效的base64 url。

+ +函数签名: + +```go +func IsBase64URL(v string) bool +``` + +示例: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsBase64URL("SAGsbG8sIHdvcmxkIQ") + result2 := validator.IsBase64URL("SAGsbG8sIHdvcmxkIQ==") + result3 := validator.IsBase64URL("SAGsbG8sIHdvcmxkIQ=") + result4 := validator.IsBase64URL("SAGsbG8sIHdvcmxkIQ===") + + fmt.Println(result1) + fmt.Println(result2) + fmt.Println(result3) + fmt.Println(result4) + + // Output: + // true + // true + // false + // false +} +``` + +### IsJWT + +

检查字符串是否是有效的JSON Web Token (JWT)。

+ +函数签名: + +```go +func IsJWT(v string) bool +``` + +示例: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibWVzc2FnZSI6IlB1dGluIGlzIGFic29sdXRlIHNoaXQiLCJpYXQiOjE1MTYyMzkwMjJ9.wkLWA5GtCpWdxNOrRse8yHZgORDgf8TpJp73WUQb910") + result2 := validator.IsJWT("abc") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +} +``` + +### IsVisa + +

检查字符串是否是有效的visa卡号。

+ +函数签名: + +```go +func IsVisa(v string) bool +``` + +示例: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsVisa("4111111111111111") + result2 := validator.IsVisa("123") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +} +``` + +### IsMasterCard + +

检查字符串是否是有效的MasterCard卡号。

+ +函数签名: + +```go +func IsMasterCard(v string) bool +``` + +示例: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsMasterCard("5425233430109903") + result2 := validator.IsMasterCard("4111111111111111") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +} +``` + +### IsAmericanExpress + +

检查字符串是否是有效的American Express卡号。

+ +函数签名: + +```go +func IsAmericanExpress(v string) bool +``` + +示例: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsAmericanExpress("342883359122187") + result2 := validator.IsAmericanExpress("3782822463100007") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +} +``` + +### IsVisa + +

检查字符串是否是有效的美国银联卡号。

+ +函数签名: + +```go +func IsUnionPay(v string) bool +``` + +示例: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsUnionPay("6221263430109903") + result2 := validator.IsUnionPay("3782822463100007") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +} +``` + +### IsChinaUnionPay + +

检查字符串是否是有效的中国银联卡号。

+ +函数签名: + +```go +func IsChinaUnionPay(v string) bool +``` + +示例: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsChinaUnionPay("6250941006528599") + result2 := validator.IsChinaUnionPay("3782822463100007") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +} +``` diff --git a/docs/en/api/packages/validator.md b/docs/en/api/packages/validator.md index 48ab3f8..8884fad 100644 --- a/docs/en/api/packages/validator.md +++ b/docs/en/api/packages/validator.md @@ -55,6 +55,15 @@ import ( - [IsZeroValue](#IsZeroValue) - [IsGBK](#IsGBK) - [IsPrintable](#IsPrintable) +- [IsBin](#IsBin) +- [IsHex](#IsHex) +- [IsBase64URL](#IsBase64URL) +- [IsJWT](#IsJWT) +- [IsVisa](#IsVisa) +- [IsMasterCard](#IsMasterCard) +- [IsAmericanExpress](#IsAmericanExpress) +- [IsUnionPay](#IsUnionPay) +- [IsChinaUnionPay](#IsChinaUnionPay)
@@ -1188,3 +1197,300 @@ func main() { // false } ``` + +### IsBin + +

Checks if a give string is a valid binary value or not.

+ +Signature: + +```go +func IsBin(v string) bool +``` + +Example: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsBin("0101") + result2 := validator.IsBin("0b1101") + result3 := validator.IsBin("b1101") + result4 := validator.IsBin("1201") + + fmt.Println(result1) + fmt.Println(result2) + fmt.Println(result3) + fmt.Println(result4) + + // Output: + // true + // true + // false + // false +} +``` + +### IsHex + +

Checks if a give string is a valid hexadecimal value or not.

+ +Signature: + +```go +func IsHex(v string) bool +``` + +Example: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsHex("0xabcde") + result2 := validator.IsHex("0XABCDE") + result3 := validator.IsHex("cdfeg") + result4 := validator.IsHex("0xcdfeg") + + fmt.Println(result1) + fmt.Println(result2) + fmt.Println(result3) + fmt.Println(result4) + + // Output: + // true + // true + // false + // false +} +``` + +### IsBase64URL + +

Checks if a give string is a valid URL-safe Base64 encoded string.

+ +Signature: + +```go +func IsBase64URL(v string) bool +``` + +Example: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsBase64URL("SAGsbG8sIHdvcmxkIQ") + result2 := validator.IsBase64URL("SAGsbG8sIHdvcmxkIQ==") + result3 := validator.IsBase64URL("SAGsbG8sIHdvcmxkIQ=") + result4 := validator.IsBase64URL("SAGsbG8sIHdvcmxkIQ===") + + fmt.Println(result1) + fmt.Println(result2) + fmt.Println(result3) + fmt.Println(result4) + + // Output: + // true + // true + // false + // false +} +``` + +### IsJWT + +

Checks if a give string is is a valid JSON Web Token (JWT).

+ +Signature: + +```go +func IsJWT(v string) bool +``` + +Example: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibWVzc2FnZSI6IlB1dGluIGlzIGFic29sdXRlIHNoaXQiLCJpYXQiOjE1MTYyMzkwMjJ9.wkLWA5GtCpWdxNOrRse8yHZgORDgf8TpJp73WUQb910") + result2 := validator.IsJWT("abc") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +} +``` + +### IsVisa + +

Checks if a give string is a valid visa card nubmer or not.

+ +Signature: + +```go +func IsVisa(v string) bool +``` + +Example: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsVisa("4111111111111111") + result2 := validator.IsVisa("123") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +} +``` + +### IsMasterCard + +

Checks if a give string is a valid mastercard nubmer or not.

+ +Signature: + +```go +func IsMasterCard(v string) bool +``` + +Example: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsMasterCard("5425233430109903") + result2 := validator.IsMasterCard("4111111111111111") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +} +``` + +### IsAmericanExpress + +

Checks if a give string is a valid american express nubmer or not.

+ +Signature: + +```go +func IsAmericanExpress(v string) bool +``` + +Example: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsAmericanExpress("342883359122187") + result2 := validator.IsAmericanExpress("3782822463100007") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +} +``` + +### IsVisa + +

Checks if a give string is a valid union pay nubmer or not.

+ +Signature: + +```go +func IsUnionPay(v string) bool +``` + +Example: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsUnionPay("6221263430109903") + result2 := validator.IsUnionPay("3782822463100007") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +} +``` + +### IsChinaUnionPay + +

Checks if a give string is a valid china union pay nubmer or not.

+ +Signature: + +```go +func IsChinaUnionPay(v string) bool +``` + +Example: + +```go +import ( + "fmt" + "github.com/duke-git/lancet/v2/validator" +) + +func main() { + result1 := validator.IsChinaUnionPay("6250941006528599") + result2 := validator.IsChinaUnionPay("3782822463100007") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +} +``` diff --git a/validator/validator_example_test.go b/validator/validator_example_test.go index 6ecde76..4056f23 100644 --- a/validator/validator_example_test.go +++ b/validator/validator_example_test.go @@ -587,3 +587,63 @@ func ExampleIsJWT() { // true // false } + +func ExampleIsVisa() { + result1 := IsVisa("4111111111111111") + result2 := IsVisa("123") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +} + +func ExampleIsMasterCard() { + result1 := IsMasterCard("5425233430109903") + result2 := IsMasterCard("4111111111111111") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +} + +func ExampleIsAmericanExpress() { + result1 := IsAmericanExpress("342883359122187") + result2 := IsAmericanExpress("3782822463100007") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +} + +func ExampleIsUnionPay() { + result1 := IsUnionPay("6221263430109903") + result2 := IsUnionPay("3782822463100007") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +} + +func ExampleIsChinaUnionPay() { + result1 := IsChinaUnionPay("6250941006528599") + result2 := IsChinaUnionPay("3782822463100007") + + fmt.Println(result1) + fmt.Println(result2) + + // Output: + // true + // false +}