Getting Start with Date

Advantages

• Better solution for Function Encapsulation
• Enhance your code Maintainability
• Connect with other modules easily
• Modular Design

Import Module

import { date } from "jsfast";

Getting a time string

A lot of projects need to get a time string from a specific format string, but this is not easy to do with built-in Date object.

But with FastjsDate, you can do it easily.

Format string

If you don't pass a format string, it will default to Y-M-D h:m:s.

For more information about date format, scroll down to see the format string table.

date.string("Y-M-D h:m:s"); // Get the current time string
date.string("Y-M-D h:m:s", 1666351246); // Convert timestamp to string

As you can easy, it is super easy to use, we provide a clearly user-friendly API name and a simple way to use it, not only in this module but also in all modules.

Type Declaration

declare const date: {
  string: (format: string, date?: number) => string;
  date: (format: string, date: string) => Date;
  reformat: (format: string, date: string, newFormat?: string) => string;
};
export default date;

Parsing a date string

Some date picker libraries may return a string of date, but you need to convert it to a timestamp.

We provide a function to parse a date string to a timestamp easily.

date.parse(1666351246);

Using parse function

Format string

If you don't pass a format string, it will default to Y-M-D h:m:s.

For more information about date format, scroll down to see the format string table.

Misunderstanding

The param format that you pass to parse function is the format of the string you pass to the function, not what you want to return.

Function parse can parse a string or a timestamp to a parseReturn object.

There are some functions that help you to call parse easily, they all return a parseReturn object.

date.parse("2022-10-21 19:20:46", "Y-M-D h:m:s");
date.parse(1666351246, "Y-M-D h:m:s");
date.parseDate("2022-10-21 19:20:46", "Y-M-D h:m:s");
date.parseTime(1666351246, "Y-M-D h:m:s");
date.now("Y-M-D h:m:s");

Return Object

These all return an parseReturn object, and this object contains a lot of information.

Key	Description	Example
format	format string	Y-M-D h:m:s
date	Date object	2021-10-21T11:20:46.000Z
string	string of Date	2021-10-21 19:20:46
dateString	string of Date, same as string	2021-10-21 19:20:46
timestamp	timestamp of Date	1666351246
utcDate	Date object of UTC	2021-10-21T11:20:46.000Z
utcTimestamp	timestamp of UTC	1666351246
utcDateString	string of UTC	2021-10-21 19:20:46

Type Declaration

declare const _default: {
  parse: (time: string | number, format?: string) => parseReturn;
  parseDate: (date: string, format?: string | undefined) => parseReturn;
  parseTime: (time: number, format?: string | undefined) => parseReturn;
  now: (format?: string | undefined) => parseReturn;
};

export interface parseReturn {
  /** @description format string */
  format: string;
  /** @description Date object */
  date: Date;
  /** @description string of Date */
  string: string;
  /** @description string of Date, same as string */
  dateString: string;
  /** @description timestamp of Date */
  timestamp: number;
  /** @description Date object of UTC */
  utcDate: Date;
  /** @description timestamp of UTC */
  utcTimestamp: number;
  /** @description string of UTC */
  utcDateString: string;
}

Reformatting a date string

Format string

This is a simplified version of the parse function, it only returns a string of the date.

Type Declaration

declare const _default: {
  reformat: (format: string, date: string, newFormat?: string) => string;
};

Format Table

Format	Description	Example
Y	Year	2021
M	Month	01
D	Day	01
h	Hour	01
hh	Hour without prefix 0	1
m	Minute	01
mm	Minute without prefix 0	1
s	Second	01
ss	Second without prefix 0	1
S	Millisecond	613
H	Hour(12h)	01
A	AM/PM	AM
a	am/pm	am