Date API
This shows all the methods and properties of the FastjsDate
class.
export interface FastjsDateAtom {
construct: "FastjsDate";
format: string;
_date: number;
_createAt: number;
timezoneDiff: number;
}
export interface FastjsDateAPI {
changeDate(time: number | string): FastjsDate;
changeFormat(format: string): FastjsDate;
setZone(zone: number): FastjsDate;
refresh(): FastjsDate;
toNumber(utc?: boolean): number;
toActiveNumber(utc?: boolean): number;
toString(): string;
toString(showAs: "utc" | "local" | number): string;
toString(newFormat: string): string;
toString(showAs: "utc" | "local" | number, newFormat: string): string;
toActiveString(): string;
toActiveString(showAs: "utc" | "local" | number): string;
toActiveString(newFormat: string): string;
toActiveString(showAs: "utc" | "local" | number, newFormat: string): string;
}
Properties
FastjsDate.format
TIP
About the format string, see Format Table
The format of the date, it can be changed by changeFormat
or cover when calling toString
or toActiveString
.
type format = string;
FastjsDate._date
The timestamp of the date, it can be changed by changeDate
.
type _date = number;
FastjsDate._createAt
The timestamp of the date created, it can be reset by refresh
.
type _createAt = number;
FastjsDate.timezoneDiff
Readonly property
You should not change this property, unless you really know what you are doing.
The difference between the local time and UTC time.
class FastjsDate {
timezoneDiff: number;
}
Methods
FastjsDate.changeDate(time: number | string): FastjsDate
Change the date of the instance.
class FastjsDate {
changeDate(time: number | string): FastjsDate;
}
date.changeDate("2021-01-01 00:00:00"); // Change the date to "2021-01-01 00:00:00"
FastjsDate.changeFormat(format: string): FastjsDate
WARNING
It will effect to the return value of toString
and toActiveString
.
Change the format of the date.
class FastjsDate {
changeFormat(format: string): FastjsDate;
}
date.changeFormat("YYYY-MM-DD"); // Change the format to "YYYY-MM-DD"
FastjsDate.setZone(zone: number): FastjsDate
Set the timezone difference.
class FastjsDate {
setZone(zone: number): FastjsDate;
}
date.setZone(8); // Set the timezone difference to UTC+8
FastjsDate.refresh(): FastjsDate
WARNING
It will effect to the return value of toActiveString
and toActiveNumber
.
Refresh the create time of the instance.
class FastjsDate {
refresh(): FastjsDate;
}
FastjsDate.toNumber(utc?: boolean): number
Get the timestamp of the date.
class FastjsDate {
toNumber(utc?: boolean): number;
}
date.toNumber(); // Get the timestamp of the date
FastjsDate.toActiveNumber(utc?: boolean): number
Get the active timestamp of the date.
class FastjsDate {
toActiveNumber(utc?: boolean): number;
}
date.toActiveNumber(); // Get the active timestamp of the date
FastjsDate.toString
Get the date as a string.
class FastjsDate {
toString(): string;
toString(showAs: "utc" | "local" | number): string;
toString(newFormat: string): string;
toString(showAs: "utc" | "local" | number, newFormat: string): string;
}
FastjsDate.toString(): string
date.toString(); // Get the date as a string, format = date._format
FastjsDate.toString(showAs: "utc" | "local" | number): string
Deprecated parameter
You should just leave the parameter empty if you want to get utc time, parameter showAs.utc
may be removed in the future.
date.toString("utc"); // Get the date as a string in UTC
date.toString("local"); // Get the date as a string in local time
date.toString(8); // Get the date as a string in UTC+8
FastjsDate.toString(newFormat: string): string
date.toString("YYYY-MM-DD"); // Get the date as a string with format "YYYY-MM-DD"
FastjsDate.toString(showAs: "utc" | "local" | number, newFormat: string): string
Deprecated parameter
You should just leave the parameter empty if you want to get utc time, parameter showAs.utc
may be removed in the future.
date.toString("utc", "YYYY-MM-DD"); // Get the date as a string in UTC with format "YYYY-MM-DD"
date.toString("local", "YYYY-MM-DD"); // Get the date as a string in local time with format "YYYY-MM-DD"
date.toString(8, "YYYY-MM-DD"); // Get the date as a string in UTC+8 with format "YYYY-MM-DD"
FastjsDate.toActiveString
TIP
About what does the props do, see FastjsDate.toString
Get the active date as a string.
class FastjsDate {
toActiveString(): string;
toActiveString(showAs: "utc" | "local" | number): string;
toActiveString(newFormat: string): string;
toActiveString(showAs: "utc" | "local" | number, newFormat: string): string;
}