ts-py-datetime
Version:
Datetime handling the python way (or as close as possible), now with TypeScript
111 lines (110 loc) • 3.92 kB
TypeScript
import { DateParams } from '../models/date';
import { timedelta } from './timedelta';
export declare class date {
readonly year: number;
readonly month: number;
readonly day: number;
/**
* A date object represents a date (year, month, and day) in an idealized calendar,
* the current Gregorian calendar indefinitely extended in both directions.
* @param {number} year
* @param {number} month
* @param {number} day
*/
constructor(year: number, month: number, day: number);
/**
* Return a date with the same value,
* except for those parameters given new values by whichever arguments are specified.
* @param {number} [year=this.year]
* @param {number} [month=this.month]
* @param {number} [day=this.day]
* @returns {date}
*/
replace(year?: number | DateParams, month?: number, day?: number): date;
/**
* Return the proleptic Gregorian ordinal ofthe date, where January 1 of year 1 has ordinal 1.
* @returns {number}
*/
toordinal(): number;
/**
* Return the day of the week as an integer, where Monday is 0 and Sunday is 6.
* @returns {number}
*/
weekday(): number;
/**
* Return the day of the week as an integer, where Monday is 1 and Sunday is 7.
* @returns {number}
*/
isoweekday(): number;
/**
* Return an array with three components: year, week, and weekday.
* @returns {[number, number, number]}
*/
isocalendar(): number[];
/**
* Return a string representing the date in ISO 8601 format, YYYY-MM-DD.
* @returns {string}
*/
isoformat(): string;
/**
* Return the POSIX timestamp of the date, assuming it's time is midnight.
* @returns {number}
*/
valueOf(): number;
/**
* For a date d, d.toString() is equivalent to d.isoformat().
* @returns {string}
*/
toString(): string;
/**
* Return a string representing the date, such as Wed Dec 4 00:00:00 2002.
* @returns {string}
*/
ctime(): string;
/**
* Return a string representing the date, controlled by an explicit format string.
* Format codes referring to hours, minutes, or seconds will see 0 values.
* @param {string} format
* @returns {string}
*/
strftime(format: string): string;
/** Return this object as a JS Date object */
get jsDate(): Date;
/** The earliest representable date POSIX timestamp, equal to -2177434800. */
static get min(): date;
/** The latest representable date POSIX timestamp, equal to 253402232400. */
static get max(): date;
/** The smallest possible difference between non-equal date objects, 1 day, in seconds. */
static get resolution(): timedelta;
/**
* Return the current local date.
* @returns {date}
*/
static today(): date;
/**
* Return the local date corresponding to the POSIX timestamp.
* @param {number} timestamp
* @returns {date}
*/
static fromtimestamp(timestamp: number): date;
/**
* Return the date corresponding to the proleptic Gregorian ordinal, where January 1 of year 1 has ordinal 1.
* @param {number} ordinal
* @returns {date}
*/
static fromordinal(ordinal: number): date;
/**
* Return a date corresponding to a date_string given in the ISO 8601 format YYYY-MM-DD.
* @param {string} date_string
* @returns {date}
*/
static fromisoformat(date_string: string): date;
/**
* Return a date corresponding to the ISO calendar date specified by year, week, and day.
* @param {number} year
* @param {number} week
* @param {number} day
* @returns {date}
*/
static fromisocalendar(year: number, week: number, day: number): date;
}