Class Dates

Dates and times as JavaScript Date values: creating them, reading and setting their parts, and formatting them as text. Months count from 0 (January is 0, December 11) and weekdays from 0 (Sunday); days of the month count from 1. Every setter returns a new date and leaves the given one unchanged. Local-time and UTC variants exist for most operations.

Constructors

constructor

new Dates(): Bit.Dates
Returns Bit.Dates

convert

toDateString

toDateString(inputs: DateDto): string
Formats the date part as text, without the time, in the local time zone.

Example: 15 January 2024 at 14:30 -> 'Mon Jan 15 2024'
Parameters
- inputs: DateDto
  The date
Returns string
The date as text such as 'Mon Jan 15 2024'
- Defined in bitbybit-docs.d.ts:69242

toISOString

toISOString(inputs: DateDto): string
Formats the date and time in the ISO 8601 form used for data exchange, always in UTC.

Example: 15 January 2024 at 14:30 -> '2024-01-15T14:30:45.000Z'
Parameters
- inputs: DateDto
  The date
Returns string
The date as text such as '2024-01-15T14:30:45.000Z'
- Defined in bitbybit-docs.d.ts:69253

toJSON

toJSON(inputs: DateDto): string
Formats the date the way it appears inside JSON, which is the ISO 8601 form in UTC.

Example: 15 January 2024 at 14:30 -> '2024-01-15T14:30:00.000Z'
Parameters
- inputs: DateDto
  The date
Returns string
The date as text such as '2024-01-15T14:30:00.000Z'
- Defined in bitbybit-docs.d.ts:69264

toString

toString(inputs: DateDto): string
Formats the full date and time as text in the local time zone, with the zone offset.

Example: 15 January 2024 at 14:30 -> 'Mon Jan 15 2024 14:30:00 GMT+0000'
Parameters
- inputs: DateDto
  The date
Returns string
The date and time as text
- Defined in bitbybit-docs.d.ts:69275

toTimeString

toTimeString(inputs: DateDto): string
Formats the time part as text, without the date, in the local time zone with the zone offset.

Example: 15 January 2024 at 14:30 -> '14:30:45 GMT+0000'
Parameters
- inputs: DateDto
  The date
Returns string
The time as text such as '14:30:45 GMT+0000'
- Defined in bitbybit-docs.d.ts:69286

toUTCString

toUTCString(inputs: DateDto): string
Formats the date and time as text in UTC.

Example: 15 January 2024 at 14:30 -> 'Mon, 15 Jan 2024 14:30:00 GMT'
Parameters
- inputs: DateDto
  The date
Returns string
The date and time as UTC text
- Defined in bitbybit-docs.d.ts:69297

create

now

now(): Date
Gives the current date and time at the moment of the call.

Returns Date
The current date and time
- Defined in bitbybit-docs.d.ts:69305

createDate

createDate(inputs: CreateDateDto): Date
Builds a date from its parts, read in the local time zone.

The month counts from 0: 0 is January, 11 December. A part outside its range rolls over, so day 32 of January becomes the first of February. Example: year 2024, month 0, day 15, hours 14, minutes 30 -> 15 January 2024 at 14:30 local time
Parameters
- inputs: CreateDateDto
  The year, month, day, hours, minutes, seconds and milliseconds
Returns Date
The date
Example
```
const date = bitbybit.dates.createDate({ year: 2024, month: 0, day: 15, hours: 14, minutes: 30, seconds: 0, milliseconds: 0 });
```
- Defined in bitbybit-docs.d.ts:69323

createDateUTC

createDateUTC(inputs: CreateDateDto): Date
Builds a date from its parts, read as UTC so the local time zone plays no part.

The month counts from 0: 0 is January, 11 December. A part outside its range rolls over. Example: year 2024, month 0, day 15 -> 15 January 2024 at 00:00 UTC
Parameters
- inputs: CreateDateDto
  The year, month, day, hours, minutes, seconds and milliseconds
Returns Date
The date
Example
```
const date = bitbybit.dates.createDateUTC({ year: 2024, month: 0, day: 15, hours: 0, minutes: 0, seconds: 0, milliseconds: 0 });
```
- Defined in bitbybit-docs.d.ts:69339

createFromUnixTimeStamp

createFromUnixTimeStamp(inputs: CreateFromUnixTimeStampDto): Date
Builds a date from a Unix timestamp: the number of milliseconds since 1 January 1970 at 00:00 UTC.

Example: 1705329000000 -> 15 January 2024 at 14:30 UTC
Parameters
- inputs: CreateFromUnixTimeStampDto
  The timestamp in milliseconds
Returns Date
The date
Example
```
const date = bitbybit.dates.createFromUnixTimeStamp({ unixTimeStamp: 1705329000000 });
```
- Defined in bitbybit-docs.d.ts:69355

get

getDayOfMonth

getDayOfMonth(inputs: DateDto): number
Reads the day of the month, from 1 to 31, in the local time zone.

Example: 15 January 2024 -> 15
Parameters
- inputs: DateDto
  The date
Returns number
The day of the month
- Defined in bitbybit-docs.d.ts:69384

getWeekday

getWeekday(inputs: DateDto): number
Reads the day of the week in the local time zone: 0 is Sunday, 6 Saturday.

Example: 15 January 2024 -> 1, a Monday
Parameters
- inputs: DateDto
  The date
Returns number
The weekday from 0 to 6
- Defined in bitbybit-docs.d.ts:69395

getYear

getYear(inputs: DateDto): number
Reads the full year in the local time zone.

Example: 15 January 2024 -> 2024
Parameters
- inputs: DateDto
  The date
Returns number
The year
- Defined in bitbybit-docs.d.ts:69406

getMonth

getMonth(inputs: DateDto): number
Reads the month in the local time zone, counting from 0: 0 is January, 11 December.

Example: 15 January 2024 -> 0
Parameters
- inputs: DateDto
  The date
Returns number
The month from 0 to 11
- Defined in bitbybit-docs.d.ts:69417

getHours

getHours(inputs: DateDto): number
Reads the hour, from 0 to 23, in the local time zone.

Example: 14:30 -> 14
Parameters
- inputs: DateDto
  The date
Returns number
The hour
- Defined in bitbybit-docs.d.ts:69428

getMinutes

getMinutes(inputs: DateDto): number
Reads the minutes, from 0 to 59, in the local time zone.

Example: 14:30 -> 30
Parameters
- inputs: DateDto
  The date
Returns number
The minutes
- Defined in bitbybit-docs.d.ts:69439

getSeconds

getSeconds(inputs: DateDto): number
Reads the seconds, from 0 to 59, in the local time zone.

Example: 14:30:45 -> 45
Parameters
- inputs: DateDto
  The date
Returns number
The seconds
- Defined in bitbybit-docs.d.ts:69450

getMilliseconds

getMilliseconds(inputs: DateDto): number
Reads the milliseconds, from 0 to 999, in the local time zone.

Example: 14:30:45.123 -> 123
Parameters
- inputs: DateDto
  The date
Returns number
The milliseconds
- Defined in bitbybit-docs.d.ts:69461

getTime

getTime(inputs: DateDto): number
Gives the date as a Unix timestamp: the milliseconds since 1 January 1970 at 00:00 UTC.

Example: 15 January 2024 at 14:30 UTC -> 1705329000000
Parameters
- inputs: DateDto
  The date
Returns number
The timestamp in milliseconds
- Defined in bitbybit-docs.d.ts:69472

getUTCYear

getUTCYear(inputs: DateDto): number
Reads the full year in UTC.

Example: 15 January 2024 -> 2024
Parameters
- inputs: DateDto
  The date
Returns number
The year
- Defined in bitbybit-docs.d.ts:69483

getUTCMonth

getUTCMonth(inputs: DateDto): number
Reads the month in UTC, counting from 0: 0 is January, 11 December.

Example: 15 January 2024 -> 0
Parameters
- inputs: DateDto
  The date
Returns number
The month from 0 to 11
- Defined in bitbybit-docs.d.ts:69494

getUTCDay

getUTCDay(inputs: DateDto): number
Reads the day of the month, from 1 to 31, in UTC.

Example: 15 January 2024 -> 15
Parameters
- inputs: DateDto
  The date
Returns number
The day of the month
- Defined in bitbybit-docs.d.ts:69505

getUTCHours

getUTCHours(inputs: DateDto): number
Reads the hour, from 0 to 23, in UTC.

Example: 14:00 UTC -> 14
Parameters
- inputs: DateDto
  The date
Returns number
The hour
- Defined in bitbybit-docs.d.ts:69516

getUTCMinutes

getUTCMinutes(inputs: DateDto): number
Reads the minutes, from 0 to 59, in UTC.

Example: 14:30 UTC -> 30
Parameters
- inputs: DateDto
  The date
Returns number
The minutes
- Defined in bitbybit-docs.d.ts:69527

getUTCSeconds

getUTCSeconds(inputs: DateDto): number
Reads the seconds, from 0 to 59, in UTC.

Example: 14:30:45 UTC -> 45
Parameters
- inputs: DateDto
  The date
Returns number
The seconds
- Defined in bitbybit-docs.d.ts:69538

getUTCMilliseconds

getUTCMilliseconds(inputs: DateDto): number
Reads the milliseconds, from 0 to 999, in UTC.

Example: 14:30:45.123 UTC -> 123
Parameters
- inputs: DateDto
  The date
Returns number
The milliseconds
- Defined in bitbybit-docs.d.ts:69549

parse

parseDate

parseDate(inputs: DateStringDto): number
Reads a date written as text and gives its Unix timestamp, the milliseconds since 1 January 1970 at 00:00 UTC.

ISO 8601 text such as '2024-01-15' or '2024-01-15T14:30:00Z' is read reliably; text that cannot be read gives NaN. Example: '2024-01-15' -> 1705276800000
Parameters
- inputs: DateStringDto
  The date as text
Returns number
The timestamp in milliseconds, or NaN when the text is not a date
Example
```
const stamp = bitbybit.dates.parseDate({ dateString: "2024-01-15T14:30:00Z" });
```
- Defined in bitbybit-docs.d.ts:69373

set

setYear

setYear(inputs: DateYearDto): Date
Makes a copy of the date with another year, in the local time zone. The given date is not changed.

Example: 15 January 2024 with year 2025 -> 15 January 2025
Parameters
- inputs: DateYearDto
  The date and the year
Returns Date
A new date with the year changed
Example
```
const changed = bitbybit.dates.setYear({ date: bitbybit.dates.now(), year: 2025 });
```
- Defined in bitbybit-docs.d.ts:69565

setMonth

setMonth(inputs: DateMonthDto): Date
Makes a copy of the date with another month, in the local time zone; months count from 0. The given date is not changed.

Example: 15 January 2024 with month 5 -> 15 June 2024
Parameters
- inputs: DateMonthDto
  The date and the month from 0 to 11
Returns Date
A new date with the month changed
Example
```
const changed = bitbybit.dates.setMonth({ date: bitbybit.dates.now(), month: 5 });
```
- Defined in bitbybit-docs.d.ts:69581

setDayOfMonth

setDayOfMonth(inputs: DateDayDto): Date
Makes a copy of the date with another day of the month, in the local time zone. The given date is not changed.

Example: 15 January 2024 with day 20 -> 20 January 2024
Parameters
- inputs: DateDayDto
  The date and the day from 1 to 31
Returns Date
A new date with the day changed
Example
```
const changed = bitbybit.dates.setDayOfMonth({ date: bitbybit.dates.now(), day: 20 });
```
- Defined in bitbybit-docs.d.ts:69597

setHours

setHours(inputs: DateHoursDto): Date
Makes a copy of the date with another hour, in the local time zone. The given date is not changed.

Example: 14:30 with hours 9 -> 09:30
Parameters
- inputs: DateHoursDto
  The date and the hour from 0 to 23
Returns Date
A new date with the hour changed
Example
```
const changed = bitbybit.dates.setHours({ date: bitbybit.dates.now(), hours: 9 });
```
- Defined in bitbybit-docs.d.ts:69613

setMinutes

setMinutes(inputs: DateMinutesDto): Date
Makes a copy of the date with other minutes, in the local time zone. The given date is not changed.

Example: 14:30 with minutes 45 -> 14:45
Parameters
- inputs: DateMinutesDto
  The date and the minutes from 0 to 59
Returns Date
A new date with the minutes changed
Example
```
const changed = bitbybit.dates.setMinutes({ date: bitbybit.dates.now(), minutes: 45 });
```
- Defined in bitbybit-docs.d.ts:69629

setSeconds

setSeconds(inputs: DateSecondsDto): Date
Makes a copy of the date with other seconds, in the local time zone. The given date is not changed.

Example: 14:30:00 with seconds 30 -> 14:30:30
Parameters
- inputs: DateSecondsDto
  The date and the seconds from 0 to 59
Returns Date
A new date with the seconds changed
Example
```
const changed = bitbybit.dates.setSeconds({ date: bitbybit.dates.now(), seconds: 30 });
```
- Defined in bitbybit-docs.d.ts:69645

setMilliseconds

setMilliseconds(inputs: DateMillisecondsDto): Date
Makes a copy of the date with other milliseconds, in the local time zone. The given date is not changed.

Example: 14:30:00.000 with milliseconds 500 -> 14:30:00.500
Parameters
- inputs: DateMillisecondsDto
  The date and the milliseconds from 0 to 999
Returns Date
A new date with the milliseconds changed
Example
```
const changed = bitbybit.dates.setMilliseconds({ date: bitbybit.dates.now(), milliseconds: 500 });
```
- Defined in bitbybit-docs.d.ts:69661

setTime

setTime(inputs: DateTimeDto): Date
Makes a copy of the date moved to a Unix timestamp, the milliseconds since 1 January 1970 at 00:00 UTC. The given date is not changed.

Example: any date with time 0 -> 1 January 1970 at 00:00 UTC
Parameters
- inputs: DateTimeDto
  The date and the timestamp in milliseconds
Returns Date
A new date with the timestamp changed
Example
```
const changed = bitbybit.dates.setTime({ date: bitbybit.dates.now(), time: 1705329000000 });
```
- Defined in bitbybit-docs.d.ts:69677

setUTCYear

setUTCYear(inputs: DateYearDto): Date
Makes a copy of the date with another year, in UTC. The given date is not changed.

Example: 15 January 2024 with year 2025 -> 15 January 2025
Parameters
- inputs: DateYearDto
  The date and the year
Returns Date
A new date with the year changed
Example
```
const changed = bitbybit.dates.setUTCYear({ date: bitbybit.dates.now(), year: 2025 });
```
- Defined in bitbybit-docs.d.ts:69692

setUTCMonth

setUTCMonth(inputs: DateMonthDto): Date
Makes a copy of the date with another month, in UTC; months count from 0. The given date is not changed.

Example: 15 January 2024 with month 5 -> 15 June 2024
Parameters
- inputs: DateMonthDto
  The date and the month from 0 to 11
Returns Date
A new date with the month changed
Example
```
const changed = bitbybit.dates.setUTCMonth({ date: bitbybit.dates.now(), month: 5 });
```
- Defined in bitbybit-docs.d.ts:69708

setUTCDay

setUTCDay(inputs: DateDayDto): Date
Makes a copy of the date with another day of the month, in UTC. The given date is not changed.

Example: 15 January 2024 with day 20 -> 20 January 2024
Parameters
- inputs: DateDayDto
  The date and the day from 1 to 31
Returns Date
A new date with the day changed
Example
```
const changed = bitbybit.dates.setUTCDay({ date: bitbybit.dates.now(), day: 20 });
```
- Defined in bitbybit-docs.d.ts:69724

setUTCHours

setUTCHours(inputs: DateHoursDto): Date
Makes a copy of the date with another hour, in UTC. The given date is not changed.

Example: 14:30 UTC with hours 9 -> 09:30 UTC
Parameters
- inputs: DateHoursDto
  The date and the hour from 0 to 23
Returns Date
A new date with the hour changed
Example
```
const changed = bitbybit.dates.setUTCHours({ date: bitbybit.dates.now(), hours: 9 });
```
- Defined in bitbybit-docs.d.ts:69739

setUTCMinutes

setUTCMinutes(inputs: DateMinutesDto): Date
Makes a copy of the date with other minutes, in UTC. The given date is not changed.

Example: 14:30 UTC with minutes 45 -> 14:45 UTC
Parameters
- inputs: DateMinutesDto
  The date and the minutes from 0 to 59
Returns Date
A new date with the minutes changed
Example
```
const changed = bitbybit.dates.setUTCMinutes({ date: bitbybit.dates.now(), minutes: 45 });
```
- Defined in bitbybit-docs.d.ts:69754

setUTCSeconds

setUTCSeconds(inputs: DateSecondsDto): Date
Makes a copy of the date with other seconds, in UTC. The given date is not changed.

Example: 14:30:00 UTC with seconds 30 -> 14:30:30 UTC
Parameters
- inputs: DateSecondsDto
  The date and the seconds from 0 to 59
Returns Date
A new date with the seconds changed
Example
```
const changed = bitbybit.dates.setUTCSeconds({ date: bitbybit.dates.now(), seconds: 30 });
```
- Defined in bitbybit-docs.d.ts:69769

setUTCMilliseconds

setUTCMilliseconds(inputs: DateMillisecondsDto): Date
Makes a copy of the date with other milliseconds, in UTC. The given date is not changed.

Example: 14:30:00.000 UTC with milliseconds 500 -> 14:30:00.500 UTC
Parameters
- inputs: DateMillisecondsDto
  The date and the milliseconds from 0 to 999
Returns Date
A new date with the milliseconds changed
Example
```
const changed = bitbybit.dates.setUTCMilliseconds({ date: bitbybit.dates.now(), milliseconds: 500 });
```
- Defined in bitbybit-docs.d.ts:69784

Class Dates

Index

Constructors

convert

create

get

parse

set

Constructors

constructor

Returns Bit.Dates

convert

toDateString

Parameters

Returns string

toISOString

Parameters

Returns string

toJSON

Parameters

Returns string

toString

Parameters

Returns string

toTimeString

Parameters

Returns string

toUTCString

Parameters

Returns string

create

now

Returns Date

createDate

Parameters

Returns Date

Example

createDateUTC

Parameters

Returns Date

Example

createFromUnixTimeStamp

Parameters

Returns Date

Example

get

getDayOfMonth

Parameters

Returns number

getWeekday

Parameters

Returns number

getYear

Parameters

Returns number

getMonth

Parameters

Returns number

getHours

Parameters

Returns number

getMinutes

Parameters

Returns number

getSeconds

Parameters

Returns number

getMilliseconds

Parameters

Returns number

getTime

Parameters

Returns number

getUTCYear

Parameters

Returns number

getUTCMonth

Parameters

Returns number

getUTCDay