webmcp
view 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 | 
 line source
     1 --[[--
     2 text =                 -- a string
     3 format.string(
     4   value,               -- any value where tostring(value) gives a reasonable result
     5   {
     6     nil_as = nil_text  -- text to be returned for a nil value
     7   }
     8 )
    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.
    12 --]]--
    14 function format.string(str, options)
    15   local options = options or {}
    16   if str == nil then
    17     return options.nil_as or ""
    18   else
    19     return tostring(str)
    20   end
    21 end
