# 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`  | <p>Optional format mask, or common mask. If an explicit mask is used, it should use the mask characters specified in the<br><a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/time/format/DateTimeFormatter.html">java.time.format.DateTimeFormatter</a><br>class. In compatibility mode the legacy CFML mask characters are also supported.<br>If a common mask is used, the following are supported:<br>- short: equivalent to "M/d/y h:mm tt"<br>- medium: equivalent to "MMM d, yyyy h:mm:ss tt"<br>- long: medium followed by three-letter time zone; i.e. "MMMM d, yyyy h:mm:ss tt zzz"<br>- full: equivalent to "dddd, MMMM d, yyyy H:mm:ss tt zz"<br>- ISO8601/ISO: equivalent to "yyyy-MM-dd'T'HH:mm:ssXXX"<br>- epoch: Total seconds of a given date (Example:1567517664)<br>- epochms: Total milliseconds of a given date (Example:1567517664000)</p> |         |
| `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)