diff --git a/docs/random.md b/docs/random.md new file mode 100644 index 0000000..3f751aa --- /dev/null +++ b/docs/random.md @@ -0,0 +1,107 @@ +# 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) + + +
+ +## Usage: +```go +import ( + "github.com/duke-git/lancet/random" +) +``` + +
+ +## Index +- [RandBytes](#RandBytes) +- [RandInt](#RandInt) +- [RandString](#RandString) + +
+ +## Documentation + + +### RandBytes +

Generate random byte slice.

+ +Signature: + +```go +func RandBytes(length int) []byte +``` +Example: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/random" +) + +func main() { + randBytes := random.RandBytes(4) + fmt.Println(randBytes) +} +``` + + +### RandInt +

Generate random int between min and max, may contain min, not max.

+ +Signature: + +```go +func RandInt(min, max int) int +``` +Example: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/random" +) + +func main() { + rInt := random.RandInt(1, 10) + fmt.Println(rInt) +} +``` + + + +### RandInt +

Generate random given length string.

+ +Signature: + +```go +func RandString(length int) string +``` +Example: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/random" +) + +func main() { + randStr := random.RandString(6) + fmt.Println(randStr) +} +``` + + diff --git a/docs/random_zh-CN.md b/docs/random_zh-CN.md new file mode 100644 index 0000000..b69f4aa --- /dev/null +++ b/docs/random_zh-CN.md @@ -0,0 +1,107 @@ +# Random +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) + + +
+ +## 用法: +```go +import ( + "github.com/duke-git/lancet/random" +) +``` + +
+ +## 目录 +- [RandBytes](#RandBytes) +- [RandInt](#RandInt) +- [RandString](#RandString) + +
+ +## 文档 + + +### RandBytes +

生成随机字节切片

+ +函数签名: + +```go +func RandBytes(length int) []byte +``` +例子: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/random" +) + +func main() { + randBytes := random.RandBytes(4) + fmt.Println(randBytes) +} +``` + + +### RandInt +

生成随机int, 范围[min, max)

+ +函数签名: + +```go +func RandInt(min, max int) int +``` +例子: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/random" +) + +func main() { + rInt := random.RandInt(1, 10) + fmt.Println(rInt) +} +``` + + + +### RandInt +

生成随机给定长度的随机字符串

+ +函数签名: + +```go +func RandString(length int) string +``` +例子: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/random" +) + +func main() { + randStr := random.RandString(6) + fmt.Println(randStr) +} +``` + +