Skip to content

Commit 3f7d8cf

Browse files
authoredApr 14, 2023
docs: fix examples in readme for v8.0.0 (#264)
Some updates to the examples in Readme so that they are compatible with the latest release that changed some function signatures.
1 parent fac0414 commit 3f7d8cf

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed
 

‎README.md

+14-17
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@ $ PRODUCTION=true HOSTS="host1:host2:host3" DURATION=1s go run main.go
6161
6262
- _Unexported fields_ are **ignored**
6363

64-
6564
## Supported types and defaults
6665

6766
Out of the box all built-in types are supported, plus a few others that
@@ -238,7 +237,6 @@ It will use the field name as environment variable name.
238237

239238
Here's an example:
240239

241-
242240
```go
243241
package main
244242

@@ -257,10 +255,10 @@ type Config struct {
257255

258256
func main() {
259257
cfg := &Config{}
260-
opts := &env.Options{UseFieldNameByDefault: true}
258+
opts := env.Options{UseFieldNameByDefault: true}
261259

262260
// Load env vars.
263-
if err := env.Parse(cfg, opts); err != nil {
261+
if err := env.ParseWithOptions(cfg, opts); err != nil {
264262
log.Fatal(err)
265263
}
266264

@@ -293,12 +291,12 @@ type Config struct {
293291

294292
func main() {
295293
cfg := &Config{}
296-
opts := &env.Options{Environment: map[string]string{
294+
opts := env.Options{Environment: map[string]string{
297295
"PASSWORD": "MY_PASSWORD",
298296
}}
299297

300298
// Load env vars.
301-
if err := env.Parse(cfg, opts); err != nil {
299+
if err := env.ParseWithOptions(cfg, opts); err != nil {
302300
log.Fatal(err)
303301
}
304302

@@ -313,6 +311,7 @@ You can change what tag name to use for setting the env vars by setting the `Opt
313311
variable.
314312

315313
For example
314+
316315
```go
317316
package main
318317

@@ -329,10 +328,10 @@ type Config struct {
329328

330329
func main() {
331330
cfg := &Config{}
332-
opts := &env.Options{TagName: "json"}
331+
opts := env.Options{TagName: "json"}
333332

334333
// Load env vars.
335-
if err := env.Parse(cfg, opts); err != nil {
334+
if err := env.ParseWithOptions(cfg, opts); err != nil {
336335
log.Fatal(err)
337336
}
338337

@@ -369,21 +368,19 @@ type ComplexConfig struct {
369368
}
370369

371370
func main() {
372-
cfg := ComplexConfig{}
373-
if err := Parse(&cfg, Options{
371+
cfg := &ComplexConfig{}
372+
opts := env.Options{
374373
Prefix: "T_",
375374
Environment: map[string]string{
376375
"T_FOO_HOME": "/foo",
377376
"T_BAR_HOME": "/bar",
378377
"T_BLAH": "blahhh",
379378
"T_HOME": "/clean",
380379
},
381-
}); err != nil {
382-
log.Fatal(err)
383380
}
384381

385382
// Load env vars.
386-
if err := env.Parse(cfg, opts); err != nil {
383+
if err := env.ParseWithOptions(cfg, opts); err != nil {
387384
log.Fatal(err)
388385
}
389386

@@ -414,14 +411,14 @@ type Config struct {
414411

415412
func main() {
416413
cfg := &Config{}
417-
opts := &env.Options{
414+
opts := env.Options{
418415
OnSet: func(tag string, value interface{}, isDefault bool) {
419416
fmt.Printf("Set %s to %v (default? %v)\n", tag, value, isDefault)
420417
},
421418
}
422419

423420
// Load env vars.
424-
if err := env.Parse(cfg, opts); err != nil {
421+
if err := env.ParseWithOptions(cfg, opts); err != nil {
425422
log.Fatal(err)
426423
}
427424

@@ -453,10 +450,10 @@ type Config struct {
453450

454451
func main() {
455452
cfg := &Config{}
456-
opts := &env.Options{RequiredIfNoDef: true}
453+
opts := env.Options{RequiredIfNoDef: true}
457454

458455
// Load env vars.
459-
if err := env.Parse(cfg, opts); err != nil {
456+
if err := env.ParseWithOptions(cfg, opts); err != nil {
460457
log.Fatal(err)
461458
}
462459

0 commit comments

Comments
 (0)
Please sign in to comment.