1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
# Docs
## [faker](#)
Struct Data Fake Generator
Faker will generate you a fake data based on your Struct.
[](https://github.com/go-faker/faker/actions/workflows/go.yml)
[](https://codecov.io/gh/go-faker/faker)
[](https://goreportcard.com/report/github.com/go-faker/faker/v4)
[](https://github.com/go-faker/faker/blob/master/LICENSE)
[](https://pkg.go.dev/github.com/go-faker/faker/v4?tab=doc)
## Index
- [Support](#support)
- [Getting Started](#getting-started)
- [Example](#example)
- [Limitation](#limitation)
- [Contribution](#contribution)
## Support
You can file an [Issue](https://github.com/go-faker/faker/issues/new).
See documentation in [Go.Dev](https://pkg.go.dev/github.com/go-faker/faker/v4?tab=doc)
## Getting Started
#### Download
```shell
go get -u github.com/go-faker/faker/v4
```
# Example
---
- Using Struct's tag:
- [basic tags: example_with_tags_test.go](/example_with_tags_test.go)
- [length and bounds: example_with_tags_lenbounds_test.go](/example_with_tags_lenbounds_test.go)
- [language: example_with_tags_lang_test.go](/example_with_tags_lang_test.go)
- [unique: example_with_tags_unique_test.go](example_with_tags_unique_test.go)
- [slice length: example_with_tags_slicelength_test.go](example_with_tags_slicelength_test.go)
- Custom Struct's tag (define your own faker data): [example_custom_faker_test.go](/example_custom_faker_test.go)
- Without struct's tag: [example_without_tag_test.go](/example_without_tag_test.go)
- Single Fake Data Function: [example_single_fake_data_test.go](/example_single_fake_data_test.go)
- custom struct type providers : [example_custom_struct_test.go](/example_custom_struct_test.go)
- large nested (& circular) struct with map & slice size limits & depth limitations : [example_with_limits_test.go](/example_with_limits_test.go)
## DEMO
---
## Benchmark
---
Bench To Generate Fake Data
#### Without Tag
```bash
BenchmarkFakerDataNOTTagged-4 500000 3049 ns/op 488 B/op 20 allocs/op
```
#### Using Tag
```bash
BenchmarkFakerDataTagged-4 100000 17470 ns/op 380 B/op 26 allocs/op
```
### MUST KNOW
---
The Struct Field must be PUBLIC.<br>
Support For :
- pointer fields of any type
- `int`, `int8`, `int16`, `int32` & `int64`
- `uint`, `uint8`, `uint16`, `uint32` & `uint64`
- `bool`
- `string`
- `float32`, `float64`
- struct & nested struct
- `slice` / `array` of any type
- `map` of any key/value of supported types
- custom struct types by registering a `StructTypeProvider` & implementing your own generator function. This can be used for redefined time, big.Rat, etc. See [example](faker_test.go#L2655) for usage.
- default `time.Time` provider is registered, you can override it by registering your own provider.
## Limitation
---
Unfortunately this library has some limitation
- It does not support private fields. Make sure your structs fields you intend to generate fake data for are public, it would otherwise trigger a panic. You can however omit fields using a tag skip `faker:"-"` on your private fields.
- It does not support the `interface{}` data type. How could we generate anything without knowing its data type?
- It does not support the `map[interface{}]interface{}`, `map[any_type]interface{}` & `map[interface{}]any_type` data types. Once again, we cannot generate values for an unknown data type.
- Some extra custom types can be supported IF AND ONLY IF extended with [AddProvider()](https://github.com/go-faker/faker/blob/7473ac7d8d0440d24addac302c73e13c08895764/faker.go#L303) please see [example](example_custom_faker_test.go#L46)
- The `oneof` tag currently only supports `string`, the `int` types, and both `float32` & `float64`. Further support is coming soon (i.e. hex numbers, etc). See [example](example_with_tags_test.go#L53) for usage.
## Contribution
---
To contrib to this project, you can open a PR or an issue.
|
