Skip to content

Commit

Permalink
docs: fix examples in readme for v8.0.0 (#264)
Browse files Browse the repository at this point in the history
Some updates to the examples in Readme so that they are compatible with
the latest release that changed some function signatures.
  • Loading branch information
Mattias- committed Apr 14, 2023
1 parent fac0414 commit 3f7d8cf
Showing 1 changed file with 14 additions and 17 deletions.
31 changes: 14 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ $ PRODUCTION=true HOSTS="host1:host2:host3" DURATION=1s go run main.go
- _Unexported fields_ are **ignored**


## Supported types and defaults

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

Here's an example:


```go
package main

Expand All @@ -257,10 +255,10 @@ type Config struct {

func main() {
cfg := &Config{}
opts := &env.Options{UseFieldNameByDefault: true}
opts := env.Options{UseFieldNameByDefault: true}

// Load env vars.
if err := env.Parse(cfg, opts); err != nil {
if err := env.ParseWithOptions(cfg, opts); err != nil {
log.Fatal(err)
}

Expand Down Expand Up @@ -293,12 +291,12 @@ type Config struct {

func main() {
cfg := &Config{}
opts := &env.Options{Environment: map[string]string{
opts := env.Options{Environment: map[string]string{
"PASSWORD": "MY_PASSWORD",
}}

// Load env vars.
if err := env.Parse(cfg, opts); err != nil {
if err := env.ParseWithOptions(cfg, opts); err != nil {
log.Fatal(err)
}

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

For example

```go
package main

Expand All @@ -329,10 +328,10 @@ type Config struct {

func main() {
cfg := &Config{}
opts := &env.Options{TagName: "json"}
opts := env.Options{TagName: "json"}

// Load env vars.
if err := env.Parse(cfg, opts); err != nil {
if err := env.ParseWithOptions(cfg, opts); err != nil {
log.Fatal(err)
}

Expand Down Expand Up @@ -369,21 +368,19 @@ type ComplexConfig struct {
}

func main() {
cfg := ComplexConfig{}
if err := Parse(&cfg, Options{
cfg := &ComplexConfig{}
opts := env.Options{
Prefix: "T_",
Environment: map[string]string{
"T_FOO_HOME": "/foo",
"T_BAR_HOME": "/bar",
"T_BLAH": "blahhh",
"T_HOME": "/clean",
},
}); err != nil {
log.Fatal(err)
}

// Load env vars.
if err := env.Parse(cfg, opts); err != nil {
if err := env.ParseWithOptions(cfg, opts); err != nil {
log.Fatal(err)
}

Expand Down Expand Up @@ -414,14 +411,14 @@ type Config struct {

func main() {
cfg := &Config{}
opts := &env.Options{
opts := env.Options{
OnSet: func(tag string, value interface{}, isDefault bool) {
fmt.Printf("Set %s to %v (default? %v)\n", tag, value, isDefault)
},
}

// Load env vars.
if err := env.Parse(cfg, opts); err != nil {
if err := env.ParseWithOptions(cfg, opts); err != nil {
log.Fatal(err)
}

Expand Down Expand Up @@ -453,10 +450,10 @@ type Config struct {

func main() {
cfg := &Config{}
opts := &env.Options{RequiredIfNoDef: true}
opts := env.Options{RequiredIfNoDef: true}

// Load env vars.
if err := env.Parse(cfg, opts); err != nil {
if err := env.ParseWithOptions(cfg, opts); err != nil {
log.Fatal(err)
}

Expand Down

0 comments on commit 3f7d8cf

Please sign in to comment.