# DateFormat

Formats a datetime, date or time

## Method Signature

```
DateFormat(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%2Fjava%2Fjavase%2F21%2Fdocs%2Fapi%2F%2F/java.base/java/time/format/DateTimeFormatter.html">java.time.format.DateTimeFormatter</a> class.<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

* [ClearTimezone](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/cleartimezone)
* [CreateDate](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/createdate)
* [CreateDateTime](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/createdatetime)
* [CreateODBCDate](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/createodbcdate)
* [CreateODBCDateTime](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/createodbcdatetime)
* [CreateODBCTime](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/createodbctime)
* [CreateTime](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/createtime)
* [CreateTimeSpan](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/createtimespan)
* [DateAdd](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/dateadd)
* [DateCompare](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/datecompare)
* [DateConvert](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/dateconvert)
* [DateDiff](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/datediff)
* [DatePart](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/datepart)
* [DateTimeFormat](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/datetimeformat)
* [Day](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/day)
* [DayOfWeek](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/dayofweek)
* [DayOfWeekAsString](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/dayofweekasstring)
* [DayOfWeekShortAsString](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/dayofweekshortasstring)
* [DayOfYear](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/dayofyear)
* [DaysInMonth](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/daysinmonth)
* [DaysInYear](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/daysinyear)
* [FirstDayOfMonth](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/firstdayofmonth)
* [GetNumericDate](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/getnumericdate)
* [GetTime](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/gettime)
* [GetTimezone](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/gettimezone)
* [GetTimezoneInfo](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/gettimezoneinfo)
* [Hour](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/hour)
* [Millisecond](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/millisecond)
* [Minute](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/minute)
* [Month](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/month)
* [MonthAsString](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/monthasstring)
* [MonthShortAsString](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/monthshortasstring)
* [Nanosecond](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/nanosecond)
* [Now](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/now)
* [Offset](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/offset)
* [ParseDateTime](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/parsedatetime)
* [Quarter](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/quarter)
* [Second](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/second)
* [SetTimezone](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/settimezone)
* [TimeFormat](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/timeformat)
* [TimeUnits](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/timeunits)
* [Week](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/week)
* [Year](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/year)