# TimeFormat Formats a datetime, date or time ## Method Signature ``` TimeFormat(date=[any], mask=[string], timezone=[string], locale=[string]) ``` ### Arguments | Argument | Type | Required | Description | Default | | ---------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | `date` | `any` | `true` | The date string or object | | | `mask` | `string` | `false` |

Optional format mask, or common mask. If an explicit mask is used, it should use the mask characters specified in the
java.time.format.DateTimeFormatter
class. In compatibility mode the legacy CFML mask characters are also supported.
If a common mask is used, the following are supported:
- short: equivalent to "M/d/y h:mm tt"
- medium: equivalent to "MMM d, yyyy h:mm:ss tt"
- long: medium followed by three-letter time zone; i.e. "MMMM d, yyyy h:mm:ss tt zzz"
- full: equivalent to "dddd, MMMM d, yyyy H:mm:ss tt zz"
- ISO8601/ISO: equivalent to "yyyy-MM-dd'T'HH:mm:ssXXX"
- epoch: Total seconds of a given date (Example:1567517664)
- epochms: Total milliseconds of a given date (Example:1567517664000)

| | | `timezone` | `string` | `false` | Optional specific timezone to apply to the date ( if not present in the date string ) | | | `locale` | `string` | `false` | Optional ISO locale string which will be used to localize the resulting date/time string | | ## Examples ## Related * [createDate](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/createdate) * [DateCompare](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/datecompare) * [DateFormat](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/dateformat) * [DateTimeFormat](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/datetimeformat) * [DayOfWeekAsString](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/dayofweekasstring) * [DayOfWeekShortAsString](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/dayofweekshortasstring) * [GetHTTPTimestring](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/broken-reference) * [LSDateFormat](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/lsdateformat) * [LSDateTimeFormat](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/lsdatetimeformat) * [LSDayOfWeek](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/lsdayofweek) * [LSIsDate](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/lsisdate) * [LSParseDateTime](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/lsparsedatetime) * [LSTimeFormat](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/lstimeformat) * [LSWeek](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/lsweek) * [MonthAsString](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/monthasstring) * [MonthShortAsString](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/monthshortasstring) * [ParseDateTime](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/parsedatetime) * [ToLegacyDate](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/tolegacydate) --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/timeformat.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.