git/lancet
1
0
Fork 0
mirror of https://github.com/duke-git/lancet.git synced 2026-02-10 07:42:27 +08:00
Code Issues Projects Releases Wiki Activity

update doc

Browse Source
This commit is contained in:
dudaodong
2024-12-04 10:40:18 +08:00
parent e1e15883e9
commit 4595a94b4c
14 changed files with 342 additions and 196 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/compare.md
View File

@@ -42,7 +42,7 @@ import (
<b>Signature:</b>
```go
func Equal(left, right any) bool
func Equal(left, right interface{}) bool
```
<b>Example:</b>
@@ -91,7 +91,7 @@ func main() {
<b>Signature:</b>
```go
func EqualValue(left, right any) bool
func EqualValue(left, right interface{}) bool
```
<b>Example:</b>
@@ -130,7 +130,7 @@ func main() {
<b>Signature:</b>
```go
func LessThan(left, right any) bool
func LessThan(left, right interface{}) bool
```
<b>Example:</b>
@@ -179,7 +179,7 @@ func main() {
<b>Signature:</b>
```go
func GreaterThan(left, right any) bool
func GreaterThan(left, right interface{}) bool
```
<b>Example:</b>
@@ -231,7 +231,7 @@ func main() {
<b>Signature:</b>
```go
func LessOrEqual(left, right any) bool
func LessOrEqual(left, right interface{}) bool
```
<b>Example:</b>
@@ -280,7 +280,7 @@ func main() {
<b>Signature:</b>
```go
func GreaterOrEqual(left, right any) bool
func GreaterOrEqual(left, right interface{}) bool
```
<b>Example:</b>

12
docs/compare_zh-CN.md
View File

@@ -42,7 +42,7 @@ import (
<b>函数签名:</b>
```go
func Equal(left, right any) bool
func Equal(left, right interface{}) bool
```
<b>示例:</b>
@@ -91,7 +91,7 @@ func main() {
<b>函数签名:</b>
```go
func EqualValue(left, right any) bool
func EqualValue(left, right interface{}) bool
```
<b>示例:</b>
@@ -130,7 +130,7 @@ func main() {
<b>函数签名:</b>
```go
func LessThan(left, right any) bool
func LessThan(left, right interface{}) bool
```
<b>示例:</b>
@@ -179,7 +179,7 @@ func main() {
<b>函数签名:</b>
```go
func GreaterThan(left, right any) bool
func GreaterThan(left, right interface{}) bool
```
<b>示例:</b>
@@ -231,7 +231,7 @@ func main() {
<b>函数签名:</b>
```go
func LessOrEqual(left, right any) bool
func LessOrEqual(left, right interface{}) bool
```
<b>示例:</b>
@@ -280,7 +280,7 @@ func main() {
<b>函数签名:</b>
```go
func GreaterOrEqual(left, right any) bool
func GreaterOrEqual(left, right interface{}) bool
```
<b>示例:</b>

54
docs/convertor.md
View File

@@ -45,7 +45,7 @@ import (
- [ToUrlBase64](#ToUrlBase64)
- [ToRawStdBase64](#ToRawStdBase64)
- [ToRawUrlBase64](#ToRawUrlBase64)
- [ToBigInt](#ToBigInt)
<div STYLE="page-break-after: always;"></div>
@@ -454,7 +454,7 @@ func main() {
<b>Signature:</b>
```go
func EncodeByte(data any) ([]byte, error)
func EncodeByte(data interface{}) ([]byte, error)
```
<b>Example:</b>
@@ -480,7 +480,7 @@ func main() {
<b>Signature:</b>
```go
func DecodeByte(data []byte, target any) error
func DecodeByte(data []byte, target interface{}) error
```
<b>Example:</b>
@@ -508,7 +508,7 @@ func main() {
<b>Signature:</b>
```go
func DeepClone[T any](src T) T
func DeepClone[T interface{}](src T) T
```
<b>Example:</b>
@@ -753,7 +753,7 @@ func main() {
<b>Signature:</b>
```go
func ToStdBase64(value any) string
func ToStdBase64(value interface{}) string
```
<b>Example:</b>
@@ -785,7 +785,7 @@ func main() {
afterEncode = convertor.ToStdBase64(intVal)
fmt.Println(afterEncode)
mapVal := map[string]any{"a": "hi", "b": 2, "c": struct {
mapVal := map[string]interface{}{"a": "hi", "b": 2, "c": struct {
A string
B int
}{"hello", 3}}
@@ -825,7 +825,7 @@ func main() {
<b>Signature:</b>
```go
func ToUrlBase64(value any) string
func ToUrlBase64(value interface{}) string
```
<b>Example:</b>
@@ -855,7 +855,7 @@ func main() {
afterEncode = convertor.ToUrlBase64(intVal)
fmt.Println(afterEncode)
mapVal := map[string]any{"a": "hi", "b": 2, "c": struct {
mapVal := map[string]interface{}{"a": "hi", "b": 2, "c": struct {
A string
B int
}{"hello", 3}}
@@ -894,7 +894,7 @@ func main() {
<b>Signature:</b>
```go
func ToRawStdBase64(value any) string
func ToRawStdBase64(value interface{}) string
```
<b>Example:</b>
@@ -921,7 +921,7 @@ func main() {
afterEncode = convertor.ToRawStdBase64(intVal)
fmt.Println(afterEncode)
mapVal := map[string]any{"a": "hi", "b": 2, "c": struct {
mapVal := map[string]interface{}{"a": "hi", "b": 2, "c": struct {
A string
B int
}{"hello", 3}}
@@ -958,7 +958,7 @@ func main() {
<b>Signature:</b>
```go
func ToRawUrlBase64(value any) string
func ToRawUrlBase64(value interface{}) string
```
<b>Example:</b>
@@ -985,7 +985,7 @@ func main() {
afterEncode = convertor.ToRawUrlBase64(intVal)
fmt.Println(afterEncode)
mapVal := map[string]any{"a": "hi", "b": 2, "c": struct {
mapVal := map[string]interface{}{"a": "hi", "b": 2, "c": struct {
A string
B int
}{"hello", 3}}
@@ -1013,4 +1013,34 @@ func main() {
// dHJ1ZQ
// ZXJy
}
```
### <span id="ToBigInt">ToBigInt</span>
<p>Convert value to bigInt.</p>
<b>Signature:</b>
```go
func ToBigInt(v interface{}) (*big.Int, error)
```
<b>Example:</b>
```go
package main
import (
"fmt"
"github.com/duke-git/lancet/convertor"
)
func main() {
n := 9876543210
bigInt, _ := convertor.ToBigInt(n)
fmt.Println(bigInt)
// Output:
// 9876543210
}
```

61
docs/convertor_zh-CN.md
View File

@@ -45,6 +45,7 @@ import (
- [ToUrlBase64](#ToUrlBase64)
- [ToRawStdBase64](#ToRawStdBase64)
- [ToRawUrlBase64](#ToRawUrlBase64)
- [ToBigInt](#ToBigInt)
<div STYLE="page-break-after: always;"></div>
@@ -453,7 +454,7 @@ func main() {
<b>函数签名:</b>
```go
func EncodeByte(data any) ([]byte, error)
func EncodeByte(data interface{}) ([]byte, error)
```
<b>例子:</b>
@@ -479,7 +480,7 @@ func main() {
<b>函数签名:</b>
```go
func DecodeByte(data []byte, target any) error
func DecodeByte(data []byte, target interface{}) error
```
<b>例子:</b>
@@ -507,7 +508,7 @@ func main() {
<b>函数签名:</b>
```go
func DeepClone[T any](src T) T
func DeepClone[T interface{}](src T) T
```
<b>示例:</b>
@@ -753,7 +754,7 @@ func main() {
<b>函数签名:</b>
```go
func ToStdBase64(value any) string
func ToStdBase64(value interface{}) string
```
<b>示例:</b>
@@ -763,7 +764,7 @@ package main
import (
"fmt"
"github.com/duke-git/lancet/v2/convertor"
"github.com/duke-git/lancet/convertor"
)
func main() {
@@ -785,7 +786,7 @@ func main() {
afterEncode = convertor.ToStdBase64(intVal)
fmt.Println(afterEncode)
mapVal := map[string]any{"a": "hi", "b": 2, "c": struct {
mapVal := map[string]interface{}{"a": "hi", "b": 2, "c": struct {
A string
B int
}{"hello", 3}}
@@ -825,7 +826,7 @@ func main() {
<b>函数签名:</b>
```go
func ToUrlBase64(value any) string
func ToUrlBase64(value interface{}) string
```
<b>示例:</b>
@@ -835,7 +836,7 @@ package main
import (
"fmt"
"github.com/duke-git/lancet/v2/convertor"
"github.com/duke-git/lancet/convertor"
)
func main() {
@@ -855,7 +856,7 @@ func main() {
afterEncode = convertor.ToUrlBase64(intVal)
fmt.Println(afterEncode)
mapVal := map[string]any{"a": "hi", "b": 2, "c": struct {
mapVal := map[string]interface{}{"a": "hi", "b": 2, "c": struct {
A string
B int
}{"hello", 3}}
@@ -894,7 +895,7 @@ func main() {
<b>函数签名:</b>
```go
func ToRawStdBase64(value any) string
func ToRawStdBase64(value interface{}) string
```
<b>示例:</b>
@@ -904,7 +905,7 @@ package main
import (
"fmt"
"github.com/duke-git/lancet/v2/convertor"
"github.com/duke-git/lancet/convertor"
)
func main() {
@@ -921,7 +922,7 @@ func main() {
afterEncode = convertor.ToRawStdBase64(intVal)
fmt.Println(afterEncode)
mapVal := map[string]any{"a": "hi", "b": 2, "c": struct {
mapVal := map[string]interface{}{"a": "hi", "b": 2, "c": struct {
A string
B int
}{"hello", 3}}
@@ -958,7 +959,7 @@ func main() {
<b>函数签名:</b>
```go
func ToRawUrlBase64(value any) string
func ToRawUrlBase64(value interface{}) string
```
<b>示例:</b>
@@ -968,7 +969,7 @@ package main
import (
"fmt"
"github.com/duke-git/lancet/v2/convertor"
"github.com/duke-git/lancet/convertor"
)
func main() {
@@ -985,7 +986,7 @@ func main() {
afterEncode = convertor.ToRawUrlBase64(intVal)
fmt.Println(afterEncode)
mapVal := map[string]any{"a": "hi", "b": 2, "c": struct {
mapVal := map[string]interface{}{"a": "hi", "b": 2, "c": struct {
A string
B int
}{"hello", 3}}
@@ -1013,4 +1014,34 @@ func main() {
// dHJ1ZQ
// ZXJy
}
```
### <span id="ToBigInt">ToBigInt</span>
<p>将整数值转换为bigInt。</p>
<b>函数签名:</b>
```go
func ToBigInt(v interface{}) (*big.Int, error)
```
<b>示例:</b>
```go
package main
import (
"fmt"
"github.com/duke-git/lancet/convertor"
)
func main() {
n := 9876543210
bigInt, _ := convertor.ToBigInt(n)
fmt.Println(bigInt)
// Output:
// 9876543210
}
```

2
docs/datetime.md
View File

@@ -1381,7 +1381,7 @@ package main
import (
"fmt"
"github.com/duke-git/lancet/v2/datetime"
"github.com/duke-git/lancet/datetime"
)
func main() {

2
docs/fileutil.md
View File

@@ -902,7 +902,7 @@ package main
import (
"fmt"
"github.com/duke-git/lancet/v2/fileutil"
"github.com/duke-git/lancet/fileutil"
)
func main() {

2
docs/fileutil_zh-CN.md
View File

@@ -900,7 +900,7 @@ package main
import (
"fmt"
"github.com/duke-git/lancet/v2/fileutil"
"github.com/duke-git/lancet/fileutil"
)
func main() {

2
docs/validator.md
View File

@@ -1225,7 +1225,7 @@ func IsMasterCard(v string) bool
```go
import (
"fmt"
"github.com/duke-git/lancet/v2/validator"
"github.com/duke-git/lancet/validator"
)
func main() {