summaryrefslogtreecommitdiff
path: root/datetime/mod.ts
diff options
context:
space:
mode:
authorVincent LE GOFF <g_n_s@hotmail.fr>2019-03-14 15:24:54 +0100
committerRyan Dahl <ry@tinyclouds.org>2019-03-14 10:24:54 -0400
commit0b4f73cf9d6e7674c76126fc9d37defb58e7a433 (patch)
treea7f47f908cf81ea36771b537fe043d3ed17bfc34 /datetime/mod.ts
parenta391660d2d539e3ca71418604e34df6c50dd6502 (diff)
Improve jsdoc (denoland/deno_std#277)
Original: https://github.com/denoland/deno_std/commit/1805c18ac7ed3aa6727f509ee2ec55f718ff2f61
Diffstat (limited to 'datetime/mod.ts')
-rw-r--r--datetime/mod.ts21
1 files changed, 9 insertions, 12 deletions
diff --git a/datetime/mod.ts b/datetime/mod.ts
index 1e75ba4dc..a5c2648b0 100644
--- a/datetime/mod.ts
+++ b/datetime/mod.ts
@@ -3,10 +3,9 @@ export type DateFormat = "mm-dd-yyyy" | "dd-mm-yyyy" | "yyyy-mm-dd";
/**
* Parse date from string using format string
- *
- * @param {string} dateStr - date string
- * @param {DateFormat} format - format string
- * @return {Date} Parsed date
+ * @param dateStr Date string
+ * @param format Format string
+ * @return Parsed date
*/
export function parseDate(dateStr: string, format: DateFormat): Date {
let m, d, y: string;
@@ -42,10 +41,9 @@ export type DateTimeFormat =
/**
* Parse date & time from string using format string
- *
- * @param {string} dateStr - date & time string
- * @param {DateTimeFormat} format - format string
- * @return {Date} Parsed date
+ * @param dateStr Date & time string
+ * @param format Format string
+ * @return Parsed date
*/
export function parseDateTime(
datetimeStr: string,
@@ -88,9 +86,9 @@ export function parseDateTime(
/**
* Get number of the day in the year
- * @return {number} Number of the day in year
+ * @return Number of the day in year
*/
-export function dayOfYear(date: Date): any {
+export function dayOfYear(date: Date): number {
const dayMs = 1000 * 60 * 60 * 24;
const yearStart = new Date(date.getFullYear(), 0, 0);
const diff =
@@ -102,8 +100,7 @@ export function dayOfYear(date: Date): any {
/**
* Get number of current day in year
- *
- * @return {number} Number of current day in year
+ * @return Number of current day in year
*/
export function currentDayOfYear(): number {
return dayOfYear(new Date());