cfdocs

timeFormat

Formats a time value using US English time formatting conventions. If no mask is specified, returns a time value using the hh:mm tt format. For international time formatting, see LSTimeFormat.

timeFormat(time [, mask])
returns string

Member Function Syntax

time.timeFormat([mask])

Argument Reference

Name Type Required Default Description Values  
time date Yes   A date/time value or string to convert    
mask string No hh:mm tt Masking characters that determine the format.
h,hh: Hours in 12 hour format
,H,HH: Hours in 24 hour format
m,mm: Minutes
s,ss: Seconds
l: Milliseconds
t: A or P
tt: AM or PM
z: Time zone in literal format, for example GMT
Z: Time zone in hours offset (RFC822), for example +0400
X,XX,XXX: Time zone in hours of offset in ISO 8601 format
"short": h:mm tt
"medium": h:mm:ss tt
/Users/garethedwards/development/github/cfdocs/docs/functions/timeformat.md full

Format a 12 hour time with am/pm

timeFormat( createDateTime(2017, 8, 31, 15, 25, 11), "h:mm tt")

Expected Result: 3:25 PM

Member Function Example

Requires CF11+ or Lucee5+

createDateTime(2017, 8, 31, 15, 25, 11).timeFormat("h:mm tt")

Expected Result: 3:25 PM

Omitting the Mask

Should default mask to hh:mm tt

timeFormat( createDateTime(2017, 8, 31, 15, 25, 11) )

Expected Result: 03:25 PM