Interface Date

Apps Script has a non-standard Date Class

See

https://github.com/microsoft/TypeScript/blob/master/lib/lib.es5.d.ts Enables basic storage and retrieval of dates and times.

interface Date {
    getDate(): number;
    getDay(): number;
    getFullYear(): number;
    getHours(): number;
    getMilliseconds(): number;
    getMinutes(): number;
    getMonth(): number;
    getSeconds(): number;
    getTime(): number;
    getTimezoneOffset(): number;
    getUTCDate(): number;
    getUTCDay(): number;
    getUTCFullYear(): number;
    getUTCHours(): number;
    getUTCMilliseconds(): number;
    getUTCMinutes(): number;
    getUTCMonth(): number;
    getUTCSeconds(): number;
    setDate(date: number): number;
    setFullYear(year: number, month?: number, date?: number): number;
    setHours(hours: number, min?: number, sec?: number, ms?: number): number;
    setMilliseconds(ms: number): number;
    setMinutes(min: number, sec?: number, ms?: number): number;
    setMonth(month: number, date?: number): number;
    setSeconds(sec: number, ms?: number): number;
    setTime(time: number): number;
    setUTCDate(date: number): number;
    setUTCFullYear(year: number, month?: number, date?: number): number;
    setUTCHours(hours: number, min?: number, sec?: number, ms?: number): number;
    setUTCMilliseconds(ms: number): number;
    setUTCMinutes(min: number, sec?: number, ms?: number): number;
    setUTCMonth(month: number, date?: number): number;
    setUTCSeconds(sec: number, ms?: number): number;
    toDateString(): string;
    toISOString(): string;
    toJSON(key?: any): string;
    toLocaleDateString(): string;
    toLocaleString(): string;
    toLocaleTimeString(): string;
    toString(): string;
    toTimeString(): string;
    toUTCString(): string;
    valueOf(): number;
}

Index

Methods

getDate getDay getFullYear getHours getMilliseconds getMinutes getMonth getSeconds getTime getTimezoneOffset getUTCDate getUTCDay getUTCFullYear getUTCHours getUTCMilliseconds getUTCMinutes getUTCMonth getUTCSeconds setDate setFullYear setHours setMilliseconds setMinutes setMonth setSeconds setTime setUTCDate setUTCFullYear setUTCHours setUTCMilliseconds setUTCMinutes setUTCMonth setUTCSeconds toDateString toISOString toJSON toLocaleDateString toLocaleString toLocaleTimeString toString toTimeString toUTCString valueOf

Methods

getMilliseconds

getMilliseconds(): number
Gets the milliseconds of a Date, using local time.

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:438

getMinutes

getMinutes(): number
Gets the minutes of a Date object, using local time.

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:430

getMonth

getMonth(): number
Gets the month, using local time.

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:414

getSeconds

getSeconds(): number
Gets the seconds of a Date object, using local time.

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:434

getTime

getTime(): number
Gets the time value in milliseconds.

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:408

getTimezoneOffset

getTimezoneOffset(): number
Gets the difference in minutes between the time on the local computer and Universal Coordinated Time (UTC).

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:442

getUTCDate

getUTCDate(): number
Gets the day-of-the-month, using Universal Coordinated Time (UTC).

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:420

getUTCDay

getUTCDay(): number
Gets the day of the week using Universal Coordinated Time (UTC).

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:424

getUTCFullYear

getUTCFullYear(): number
Gets the year using Universal Coordinated Time (UTC).

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:412

getUTCHours

getUTCHours(): number
Gets the hours value in a Date object using Universal Coordinated Time (UTC).

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:428

getUTCMilliseconds

getUTCMilliseconds(): number
Gets the milliseconds of a Date object using Universal Coordinated Time (UTC).

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:440

getUTCMinutes

getUTCMinutes(): number
Gets the minutes of a Date object using Universal Coordinated Time (UTC).

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:432

getUTCMonth

getUTCMonth(): number
Gets the month of a Date object using Universal Coordinated Time (UTC).

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:416

getUTCSeconds

getUTCSeconds(): number
Gets the seconds of a Date object using Universal Coordinated Time (UTC).

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:436

setDate

setDate(date: number): number
Sets the numeric day-of-the-month value of the Date object using local time.
Parameters
- date: number
  
  A numeric value equal to the day of the month.
Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:504

setFullYear

setFullYear(year: number, month?: number, date?: number): number
Sets the year of the Date object using local time.
Parameters
- year: number
  
  A numeric value for the year.
- Optionalmonth: number
  
  A zero-based numeric value for the month (0 for January, 11 for December). Must be specified if numDate is specified.
- Optionaldate: number
  
  A numeric value equal for the day of the month.
Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:528

setHours

setHours(hours: number, min?: number, sec?: number, ms?: number): number
Sets the hour value in the Date object using local time.
Parameters
- hours: number
  
  A numeric value equal to the hours value.
- Optionalmin: number
  
  A numeric value equal to the minutes value.
- Optionalsec: number
  
  A numeric value equal to the seconds value.
- Optionalms: number
  
  A numeric value equal to the milliseconds value.
Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:491

setMilliseconds

setMilliseconds(ms: number): number
Sets the milliseconds value in the Date object using local time.
Parameters
- ms: number
  
  A numeric value equal to the millisecond value.
Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:452

setMinutes

setMinutes(min: number, sec?: number, ms?: number): number
Sets the minutes value in the Date object using local time.
Parameters
- min: number
  
  A numeric value equal to the minutes value.
- Optionalsec: number
  
  A numeric value equal to the seconds value.
- Optionalms: number
  
  A numeric value equal to the milliseconds value.
Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:476

setMonth

setMonth(month: number, date?: number): number
Sets the month value in the Date object using local time.
Parameters
- month: number
  
  A numeric value equal to the month. The value for January is 0, and other month values follow consecutively.
- Optionaldate: number
  
  A numeric value representing the day of the month. If this value is not supplied, the value from a call to the getDate method is used.
Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:515

setSeconds

setSeconds(sec: number, ms?: number): number
Sets the seconds value in the Date object using local time.
Parameters
- sec: number
  
  A numeric value equal to the seconds value.
- Optionalms: number
  
  A numeric value equal to the milliseconds value.
Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:463

setTime

setTime(time: number): number
Sets the date and time value in the Date object.
Parameters
- time: number
  
  A numeric value representing the number of elapsed milliseconds since midnight, January 1, 1970 GMT.
Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:447

setUTCDate

setUTCDate(date: number): number
Sets the numeric day of the month in the Date object using Universal Coordinated Time (UTC).
Parameters
- date: number
  
  A numeric value equal to the day of the month.
Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:509

setUTCFullYear

setUTCFullYear(year: number, month?: number, date?: number): number
Sets the year value in the Date object using Universal Coordinated Time (UTC).
Parameters
- year: number
  
  A numeric value equal to the year.
- Optionalmonth: number
  
  A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. Must be supplied if numDate is supplied.
- Optionaldate: number
  
  A numeric value equal to the day of the month.
Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:535

setUTCHours

setUTCHours(hours: number, min?: number, sec?: number, ms?: number): number
Sets the hours value in the Date object using Universal Coordinated Time (UTC).
Parameters
- hours: number
  
  A numeric value equal to the hours value.
- Optionalmin: number
  
  A numeric value equal to the minutes value.
- Optionalsec: number
  
  A numeric value equal to the seconds value.
- Optionalms: number
  
  A numeric value equal to the milliseconds value.
Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:499

setUTCMilliseconds

setUTCMilliseconds(ms: number): number
Sets the milliseconds value in the Date object using Universal Coordinated Time (UTC).
Parameters
- ms: number
  
  A numeric value equal to the millisecond value.
Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:457

setUTCMinutes

setUTCMinutes(min: number, sec?: number, ms?: number): number
Sets the minutes value in the Date object using Universal Coordinated Time (UTC).
Parameters
- min: number
  
  A numeric value equal to the minutes value.
- Optionalsec: number
  
  A numeric value equal to the seconds value.
- Optionalms: number
  
  A numeric value equal to the milliseconds value.
Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:483

setUTCMonth

setUTCMonth(month: number, date?: number): number
Sets the month value in the Date object using Universal Coordinated Time (UTC).
Parameters
- month: number
  
  A numeric value equal to the month. The value for January is 0, and other month values follow consecutively.
- Optionaldate: number
  
  A numeric value representing the day of the month. If it is not supplied, the value from a call to the getUTCDate method is used.
Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:521

setUTCSeconds

setUTCSeconds(sec: number, ms?: number): number
Sets the seconds value in the Date object using Universal Coordinated Time (UTC).
Parameters
- sec: number
  
  A numeric value equal to the seconds value.
- Optionalms: number
  
  A numeric value equal to the milliseconds value.
Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:469

toDateString

toDateString(): string
Returns a date as a string value.

Returns string
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:396

toISOString

toISOString(): string
Returns a date as a string value in ISO format.

Returns string
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:539

toJSON

toJSON(key?: any): string
Used by the JSON.stringify method to enable the transformation of an object's data for JavaScript Object Notation (JSON) serialization.
Parameters
- Optionalkey: any
Returns string
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:541

toLocaleDateString

toLocaleDateString(): string
Returns a date as a string value appropriate to the host environment's current locale.

Returns string
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:402

toLocaleString

toLocaleString(): string
Returns a value as a string value appropriate to the host environment's current locale.

Returns string
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:400

toLocaleTimeString

toLocaleTimeString(): string
Returns a time as a string value appropriate to the host environment's current locale.

Returns string
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:404

toString

toString(): string
Returns a string representation of a date. The format of the string depends on the locale.

Returns string
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:394

toTimeString

toTimeString(): string
Returns a time as a string value.

Returns string
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:398

toUTCString

toUTCString(): string
Returns a date converted to a string using Universal Coordinated Time (UTC).

Returns string
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:537

valueOf

valueOf(): number
Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC.

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.base.d.ts:406

Interface Date

See

Index

Methods

Methods

getDate

Returns number

getDay

Returns number

getFullYear

Returns number

getHours

Returns number

getMilliseconds

Returns number

getMinutes

Returns number

getMonth

Returns number

getSeconds

Returns number

getTime

Returns number

getTimezoneOffset

Returns number

getUTCDate

Returns number

getUTCDay

Returns number

getUTCFullYear

Returns number

getUTCHours

Returns number

getUTCMilliseconds

Returns number

getUTCMinutes

Returns number

getUTCMonth

Returns number

getUTCSeconds

Returns number

setDate

Parameters

Returns number

setFullYear

Parameters

Returns number

setHours

Parameters

Returns number

setMilliseconds

Parameters

Returns number

setMinutes

Parameters

Returns number

setMonth

Parameters

Returns number

setSeconds

Parameters

Returns number

setTime

Parameters

Returns number

setUTCDate

Parameters

Returns number

setUTCFullYear

Parameters

Returns number

setUTCHours

Parameters

Returns number

setUTCMilliseconds

Parameters

Returns number

setUTCMinutes

Parameters

Returns number