diff options
| author | Dan Edmunds <dan.edmunds@qlik.com> | 2017-10-01 13:47:43 -0400 |
|---|---|---|
| committer | Dave Henderson <dhenderson@gmail.com> | 2017-10-01 20:37:47 -0400 |
| commit | fa0aa0127cdadd6be21c02569a96376f233f00ec (patch) | |
| tree | 004a97f9009d9d50c18b13ebef47c19254597bbc | |
| parent | d2de3a53c4708548e85ce8fb384304ad940aeab4 (diff) | |
Document conv.ParseInt, conv.ParseFloat, conv.ParseUint, and conv.Atoi
| -rw-r--r-- | docs/content/functions/conv.md | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/content/functions/conv.md b/docs/content/functions/conv.md index 177a37b7..b828733a 100644 --- a/docs/content/functions/conv.md +++ b/docs/content/functions/conv.md @@ -128,3 +128,74 @@ The host is example.com:443 The path is /foo/bar ``` +## `conv.ParseInt` + +Parses a string as an int64 for later use. Equivalent to [strconv.ParseInt](https://golang.org/pkg/strconv/#ParseInt) + +#### Example + +_`input.tmpl`:_ +``` +{{ $val := conv.ParseInt (getenv "HEXVAL") 16 32 }} +The value in decimal is {{ $val }} +``` + +```console +$ HEXVAL=7C0 gomplate < input.tmpl + +The value in decimal is 1984 +``` + +## `conv.ParseFloat` + +Parses a string as an float64 for later use. Equivalent to [strconv.ParseFloat](https://golang.org/pkg/strconv/#ParseFloat) + +#### Example + +_`input.tmpl`:_ +``` +{{ $pi := conv.ParseFloat (getenv "PI") 64 }} +{{- if (gt $pi 3.0) -}} +pi is greater than 3 +{{- end }} +``` + +```console +$ PI=3.14159265359 gomplate < input.tmpl +pi is greater than 3 +``` + +## `conv.ParseUint` + +Parses a string as an uint64 for later use. Equivalent to [strconv.ParseUint](https://golang.org/pkg/strconv/#ParseUint) + +_`input.tmpl`:_ +``` +{{ conv.ParseInt (getenv "BIG") 16 64 }} is max int64 +{{ conv.ParseUint (getenv "BIG") 16 64 }} is max uint64 +``` + +```console +$ BIG=FFFFFFFFFFFFFFFF gomplate < input.tmpl +9223372036854775807 is max int64 +18446744073709551615 is max uint64 +``` + +## `conv.Atoi` + +Parses a string as an int for later use. Equivalent to [strconv.Atoi](https://golang.org/pkg/strconv/#Atoi) + +_`input.tmpl`:_ +``` +{{ $number := conv.Atoi (getenv "NUMBER") }} +{{- if (gt $number 5) -}} +The number is greater than 5 +{{- else -}} +The number is less than 5 +{{- end }} +``` + +```console +$ NUMBER=21 gomplate < input.tmpl +The number is greater than 5 +```
\ No newline at end of file |
