summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/debug/Dump.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/debug/Dump.md')
-rw-r--r--docs/content/en/functions/debug/Dump.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/content/en/functions/debug/Dump.md b/docs/content/en/functions/debug/Dump.md
new file mode 100644
index 000000000..ff505a76b
--- /dev/null
+++ b/docs/content/en/functions/debug/Dump.md
@@ -0,0 +1,50 @@
+---
+title: debug.Dump
+description: Returns an object dump as a string.
+categories: [functions]
+keywords: []
+menu:
+ docs:
+ parent: functions
+function:
+ aliases: []
+ returnType: string
+ signatures: [debug.Dump VALUE]
+relatedFunctions: []
+---
+
+```go-html-template
+{{ $data := "" }}
+{{ $p := "data/books.json" }}
+{{ with resources.Get $p }}
+ {{ $opts := dict "delimiter" "," }}
+ {{ $data = . | transform.Unmarshal $opts }}
+{{ else }}
+ {{ errorf "Unable to get resource %q" $p }}
+{{ end }}
+```
+
+```go-html-template
+<pre>{{ debug.Dump $data }}</pre>
+```
+
+```text
+[]interface {}{
+ map[string]interface {}{
+ "author": "Victor Hugo",
+ "rating": 5.0,
+ "title": "Les Misérables",
+ },
+ map[string]interface {}{
+ "author": "Victor Hugo",
+ "rating": 4.0,
+ "title": "The Hunchback of Notre Dame",
+ },
+}
+```
+
+
+
+{{% note %}}
+Output from this function may change from one release to the next. Use for debugging only.
+{{% /note %}}