add example for structconf.Parse

kevinfalting · May 10, 2024 · 24d18c6 · 24d18c6
1 parent 3e8c8d8
commit 24d18c6
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/structconf_test.go b/structconf_test.go
@@ -0,0 +1,29 @@
+package structconf_test
+
+import (
+	"context"
+	"fmt"
+	"log"
+	"os"
+
+	"github.com/kevinfalting/structconf"
+)
+
+func ExampleParse() {
+	os.Setenv("NAME", "Vikki")
+
+	type Config struct {
+		Name string `conf:"env:NAME"`
+	}
+
+	var cfg Config
+
+	if err := structconf.Parse(context.Background(), &cfg); err != nil {
+		log.Println("failed to Parse:", err)
+	}
+
+	fmt.Printf("%+v\n", cfg)
+
+	// Output:
+	// {Name:Vikki}
+}