webmcp
annotate framework/env/format/string.lua @ 108:08c107cc4fce
Documentation of "hide_seconds" flag for format.time and format.timestamp
| author | jbe |
|---|---|
| date | Sun Nov 04 18:46:29 2012 +0100 (2012-11-04) |
| parents | 9fdfb27f8e67 |
| children | 0c4841af07a5 |
| rev | line source |
|---|---|
| jbe/bsw@0 | 1 --[[-- |
| jbe/bsw@0 | 2 text = -- a string |
| jbe/bsw@0 | 3 format.string( |
| jbe/bsw@0 | 4 value, -- any value where tostring(value) gives a reasonable result |
| jbe/bsw@0 | 5 { |
| jbe/bsw@0 | 6 nil_as = nil_text -- text to be returned for a nil value |
| jbe/bsw@0 | 7 } |
| jbe/bsw@0 | 8 ) |
| jbe/bsw@0 | 9 |
| jbe/bsw@0 | 10 Formats a value as a text by calling tostring(...), unless the value is nil, in which case the text returned is chosen by the 'nil_as' option. |
| jbe/bsw@0 | 11 |
| jbe/bsw@0 | 12 --]]-- |
| jbe/bsw@0 | 13 |
| jbe/bsw@0 | 14 function format.string(str, options) |
| jbe/bsw@0 | 15 local options = options or {} |
| jbe/bsw@0 | 16 if str == nil then |
| jbe/bsw@0 | 17 return options.nil_as or "" |
| jbe/bsw@0 | 18 else |
| jbe/bsw@0 | 19 return tostring(str) |
| jbe/bsw@0 | 20 end |
| jbe/bsw@0 | 21 end |