diff --git a/docs/random.md b/docs/random.md index 69cdc92..8952062 100644 --- a/docs/random.md +++ b/docs/random.md @@ -1,16 +1,17 @@ # Random + Package random implements some basic functions to generate random int and string.
## Source: -- [https://github.com/duke-git/lancet/blob/main/random/random.go](https://github.com/duke-git/lancet/blob/main/random/random.go) - +- [https://github.com/duke-git/lancet/blob/main/random/random.go](https://github.com/duke-git/lancet/blob/main/random/random.go) ## Usage: + ```go import ( "github.com/duke-git/lancet/v2/random" @@ -20,17 +21,23 @@ import ( ## Index -- [RandBytes](#RandBytes) -- [RandInt](#RandInt) -- [RandString](#RandString) -- [UUIdV4](#UUIdV4) + +- [RandBytes](#RandBytes) +- [RandInt](#RandInt) +- [RandString](#RandString) +- [RandUpper](#RandUpper) + +- [RandLower](#RandLower) +- [RandNumeral](#RandNumeral) +- [RandNumeralOrLetter](#RandNumeralOrLetter) +- [UUIdV4](#UUIdV4) ## Documentation - ### RandBytes +Generate random byte slice.
Signature: @@ -38,6 +45,7 @@ import ( ```go func RandBytes(length int) []byte ``` + Example: ```go @@ -54,8 +62,8 @@ func main() { } ``` - ### RandInt +Generate random int between min and max, may contain min, not max.
Signature: @@ -63,6 +71,7 @@ func main() { ```go func RandInt(min, max int) int ``` + Example: ```go @@ -79,16 +88,16 @@ func main() { } ``` +### RandString - -### RandInt -Generate random given length string.
+Generate random given length string. only contains letter (a-zA-Z)
Signature: ```go func RandString(length int) string ``` + Example: ```go @@ -101,14 +110,116 @@ import ( func main() { randStr := random.RandString(6) - fmt.Println(randStr) + fmt.Println(randStr) //pGWsze } ``` +### RandUpper +Generate a random upper case string
+Signature: + +```go +func RandUpper(length int) string +``` + +Example: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/v2/random" +) + +func main() { + randStr := random.RandString(6) + fmt.Println(randStr) //PACWGF +} +``` + +### RandLower + +Generate a random lower case string
+ +Signature: + +```go +func RandLower(length int) string +``` + +Example: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/v2/random" +) + +func main() { + randStr := random.RandLower(6) + fmt.Println(randStr) //siqbew +} +``` + +### RandNumeral + +Generate a random numeral string
+ +Signature: + +```go +func RandNumeral(length int) string +``` + +Example: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/v2/random" +) + +func main() { + randStr := random.RandNumeral(6) + fmt.Println(randStr) //035172 +} +``` + +### RandNumeralOrLetter + +generate a random numeral or letter string
+ +Signature: + +```go +func RandNumeralOrLetter(length int) string +``` + +Example: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/v2/random" +) + +func main() { + randStr := random.RandNumeralOrLetter(6) + fmt.Println(randStr) //0aW7cQ +} +``` ### UUIdV4 +Generate a random UUID of version 4 according to RFC 4122.
Signature: @@ -116,6 +227,7 @@ func main() { ```go func UUIdV4() (string, error) ``` + Example: ```go @@ -134,5 +246,3 @@ func main() { fmt.Println(uuid) } ``` - - diff --git a/docs/random_zh-CN.md b/docs/random_zh-CN.md index 681edf4..1b905d9 100644 --- a/docs/random_zh-CN.md +++ b/docs/random_zh-CN.md @@ -1,16 +1,17 @@ # Random -random随机数生成器包,可以生成随机[]bytes, int, string。 + +random 随机数生成器包,可以生成随机[]bytes, int, string。 ## 源码: -- [https://github.com/duke-git/lancet/blob/main/random/random.go](https://github.com/duke-git/lancet/blob/main/random/random.go) - +- [https://github.com/duke-git/lancet/blob/main/random/random.go](https://github.com/duke-git/lancet/blob/main/random/random.go) ## 用法: + ```go import ( "github.com/duke-git/lancet/v2/random" @@ -20,18 +21,23 @@ import ( ## 目录 -- [RandBytes](#RandBytes) -- [RandInt](#RandInt) -- [RandString](#RandString) -- [UUIdV4](#UUIdV4) +- [RandBytes](#RandBytes) +- [RandInt](#RandInt) +- [RandString](#RandString) +- [RandUpper](#RandUpper) + +- [RandLower](#RandLower) +- [RandNumeral](#RandNumeral) +- [RandNumeralOrLetter](#RandNumeralOrLetter) +- [UUIdV4](#UUIdV4) ## 文档 - ### RandBytes +生成随机字节切片
函数签名: @@ -39,6 +45,7 @@ import ( ```go func RandBytes(length int) []byte ``` + 例子: ```go @@ -55,8 +62,8 @@ func main() { } ``` - ### RandInt +生成随机int, 范围[min, max)
函数签名: @@ -64,6 +71,7 @@ func main() { ```go func RandInt(min, max int) int ``` + 例子: ```go @@ -80,16 +88,16 @@ func main() { } ``` +### RandString - -### RandInt -生成随机给定长度的随机字符串
+生成给定长度的随机字符串,只包含字母(a-zA-Z)
函数签名: ```go func RandString(length int) string ``` + 例子: ```go @@ -102,13 +110,116 @@ import ( func main() { randStr := random.RandString(6) - fmt.Println(randStr) + fmt.Println(randStr) //pGWsze } ``` +### RandUpper +生成给定长度的随机大写字母字符串
+ +函数签名: + +```go +func RandUpper(length int) string +``` + +例子: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/v2/random" +) + +func main() { + randStr := random.RandString(6) + fmt.Println(randStr) //PACWGF +} +``` + +### RandLower + +生成给定长度的随机小写字母字符串
+ +函数签名: + +```go +func RandLower(length int) string +``` + +例子: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/v2/random" +) + +func main() { + randStr := random.RandLower(6) + fmt.Println(randStr) //siqbew +} +``` + +### RandNumeral + +生成给定长度的随机数字字符串
+ +函数签名: + +```go +func RandNumeral(length int) string +``` + +例子: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/v2/random" +) + +func main() { + randStr := random.RandNumeral(6) + fmt.Println(randStr) //035172 +} +``` + +### RandNumeralOrLetter + +生成给定长度的随机字符串(数字+字母)
+ +函数签名: + +```go +func RandNumeralOrLetter(length int) string +``` + +例子: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/v2/random" +) + +func main() { + randStr := random.RandNumeralOrLetter(6) + fmt.Println(randStr) //0aW7cQ +} +``` ### UUIdV4 +生成UUID v4字符串
函数签名: @@ -116,6 +227,7 @@ func main() { ```go func UUIdV4() (string, error) ``` + 例子: ```go @@ -134,5 +246,3 @@ func main() { fmt.Println(uuid) } ``` - -