Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions examples/CPF/FormatCPF.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ sidebar_position: 2

# FormatCPF


Formats an unformatted CPF to the standard `XXX.XXX.XXX-XX` pattern.

Parameters:
Expand All @@ -16,10 +15,26 @@ Return:

Usage example:
```go
formattedCPF, err := validgen.FormatCPF("12345678909")
if err != nil {
fmt.Println("Error formatting CPF:", err)
} else {
fmt.Println("Formatted CPF:", formattedCPF)
package main

import (
"fmt"
validgen "github.com/Hublastt/ValidGen"
)

func main() {

formattedCPF, err := validgen.FormatCPF("12345678909")

if err != nil {
fmt.Println("Error formatting CPF:", err)
} else {
fmt.Println("Formatted CPF:", formattedCPF)
}
}
```

Output:
```
Formatted CPF: 123.456.789-09
```
25 changes: 20 additions & 5 deletions examples/CPF/FormatGeneratedCPF.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,25 @@ Return:

Usage example:
```go
cpf, err := cpf.CPFFunctions{}.FormatGeneratedCPF()
if err != nil {
fmt.Println("Error generating CPF:", err)
} else {
fmt.Println("Generated CPF:", cpf)
package main

import (
"fmt"
validgen "github.com/Hublastt/ValidGen"
)

func main() {
cpf, err := validgen.FormatGeneratedCPF()

if err != nil {
fmt.Println("Error generating CPF:", err)
} else {
fmt.Println("Generated CPF:", cpf)
}
}
```

Output:
```
Generated CPF: 123.456.789-09
```
42 changes: 17 additions & 25 deletions examples/CPF/GenerateCPF.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,32 +12,24 @@ Return:

Usage example:
```go
cpf, err := validgen.GenerateCPF()
if err != nil {
fmt.Println("Error generating CPF:", err)
} else {
fmt.Println("Generated CPF:", cpf)
package main

import (
"fmt"
validgen "github.com/Hublastt/ValidGen"
)

func main() {
cpf, err := validgen.GenerateCPF()
if err != nil {
fmt.Println("Error generating CPF:", err)
} else {
fmt.Println("Generated CPF:", cpf)
}
}
```

---
sidebar_position: 3
---

# FormatGeneratedCPF

Generates a valid random CPF and returns it formatted.

Return:
- string: The formatted CPF.
- error: An error if something goes wrong.

Usage example:
```go
cpf, err := cpf.CPFFunctions{}.FormatGeneratedCPF()
if err != nil {
fmt.Println("Error generating CPF:", err)
} else {
fmt.Println("Generated CPF:", cpf)
}
Output:
```
Generated CPF: 12345678909
```
7 changes: 6 additions & 1 deletion examples/CPF/UnformatCPF.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ package main

import (
"fmt"
"github.com/yourusername/validgen"
validgen "github.com/Hublastt/ValidGen"
)

func main() {
Expand All @@ -32,3 +32,8 @@ func main() {
}
}
```

Output:
```
Unformatted CPF: 12345678909
```
8 changes: 5 additions & 3 deletions examples/CPF/ValidateCPF.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ sidebar_position: 1
---
# ValidateCPF


Validates whether a given CPF is valid.

Parameters:
Expand All @@ -18,7 +17,7 @@ package main

import (
"fmt"
"github.com/Hublastt/ValidGen/validgen"
validgen "github.com/Hublastt/ValidGen"
)

func main() {
Expand All @@ -29,7 +28,10 @@ func main() {
} else {
fmt.Println("Valid CPF")
}

}
```

Output:
```
Invalid CPF: <error message>
```