diff options
Diffstat (limited to 'std/datetime/README.md')
-rw-r--r-- | std/datetime/README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/std/datetime/README.md b/std/datetime/README.md new file mode 100644 index 000000000..6317ff87e --- /dev/null +++ b/std/datetime/README.md @@ -0,0 +1,37 @@ +# datetime + +Simple helper to help parse date strings into `Date`, with additional functions. + +## Usage + +### parseDate / parseDateTime + +- `parseDate()` - Take an input string and a format to parse the date. Supported formats are exported in `DateFormat`. +- `parseDateTime()` - Take an input string and a format to parse the dateTime. Supported formats are exported in `DateTimeFormat`. + +```ts +import { parseDate, parseDateTime } from 'https://deno.land/std/datetime/mod.ts' + +parseDate("03-01-2019", "dd-mm-yyyy") // output : new Date(2019, 1, 3) +parseDate("2019-01-03", "yyyy-mm-dd") // output : new Date(2019, 1, 3) +... + +parseDateTime("01-03-2019 16:34", "mm-dd-yyyy hh:mm") // output : new Date(2019, 1, 3, 16, 34) +parseDateTime("16:34 01-03-2019", "hh:mm mm-dd-yyyy") // output : new Date(2019, 1, 3, 16, 34) +... +``` + +### dayOfYear / currentDayOfYear + +- `dayOfYear()` - Returns the number of the day in the year. +- `currentDayOfYear()` - Returns the number of the current day in the year. + +```ts +import { + dayOfYear, + currentDayOfYear +} from "https://deno.land/std/datetime/mod.ts"; + +dayOfYear(new Date("2019-03-11T03:24:00")); // output: 70 +currentDayOfYear(); // output: ** depends on when you run it :) ** +``` |