# CreateTimeSpan

Creates a timespan {@link java.time.Duration}

## Method Signature

```
CreateTimeSpan(days=[numeric], hours=[numeric], minutes=[numeric], seconds=[numeric], milliseconds=[numeric])
```

### Arguments

| Argument       | Type      | Required | Description                                | Default |
| -------------- | --------- | -------- | ------------------------------------------ | ------- |
| `days`         | `numeric` | `true`   | The number of days in the timespan         |         |
| `hours`        | `numeric` | `true`   | The number of hours in the timespan        |         |
| `minutes`      | `numeric` | `true`   | The number of minutes in the timespan      |         |
| `seconds`      | `numeric` | `true`   | The number of seconds in the timespan      |         |
| `milliseconds` | `numeric` | `false`  | The number of milliseconds in the timespan | `0`     |

## Examples

### Use of createTimespan in a bx:query

The createTimespan function is useful in the cachedwithin attribute of bx:query.

```java
<bx:query name="GetParks" datasource="cfdocexamples" cachedWithin="#createTimespan( 0, 6, 0, 0 )#"> 
 SELECT PARKNAME, REGION, STATE 
 FROM Parks 
 ORDER by ParkName, State 
 </bx:query>
```

### The createTimespan function returns a numeric value

Passing 6 hours, or a quarter of a day returns a double representing 1/4

[Run Example](https://try.boxlang.io/?code=eJxLLkpNLEkNycxNLS5IzNNQMNBRMNMBkQYKmtZcAJu1CDY%3D)

```java
createTimespan( 0, 6, 0, 0 );

```

Result: PT6H

### Adding a date and a timestamp

Instead of using dateAdd you could add a timestamp to a date object

```java
dateFormat( createDate( 2017, 1, 1 ) + createTimespan( 2, 0, 0, 0 ) );

```

Result: 03-Jan-17

### Additional Examples

[Run Example](https://try.boxlang.io/?code=eJxLKc0t0FBILkpNLEkNycxNDS5IzNNQMNABIWMQpaCpoGnNpaCvD%2BTq5mbmlZakKpQAFRYDFXIBAD0DEdU%3D)

```java
dump( createTimeSpan( 0, 0, 30, 0 ) );
 // 30-minute timespan

```

## 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)
* [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)
* [DateFormat](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/temporal/dateformat)
* [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)
