diff --git a/docs/components/SuperHeader.vue b/docs/components/SuperHeader.vue index 6875db6..8b0ce0c 100644 --- a/docs/components/SuperHeader.vue +++ b/docs/components/SuperHeader.vue @@ -16,7 +16,7 @@ `" > Made with ♥ by diff --git a/docs/components/content/Data.vue b/docs/components/content/Data.vue index 84e738d..d383f0a 100644 --- a/docs/components/content/Data.vue +++ b/docs/components/content/Data.vue @@ -26,7 +26,7 @@ const fns: Record< example: "ap", }, dayOfYear: { - description: `Gets the what day of the year a given date is. For example, August 1st is the 213th day of the year on non-leapyears and 214th on leapyears.`, + description: `Gets the day of the year a given date is. For example, August 1st is the 213th day of the year on non-leap years and 214th on leap years.`, arguments: [ { name: "date", @@ -53,7 +53,7 @@ const fns: Record< }, fourDigitYear: { description: - "Converts a 2 digit year into a 4 digit year. This function assumes years 20 years into the future belong to the current century, and the past 80 are in the past.", + "Converts a 2 digit year into a 4 digit year. This function assumes years 20 years into the future belong to the current century, and the past 80 are in the past century.", arguments: [ { name: "year", @@ -104,7 +104,7 @@ const fns: Record< }, offset: { description: - "Returns the offset between two (IANA) timezones on a given date. The results are ISO8601 compatible string offsets like -0800 or +0530.", + "Returns the offset between two (IANA) timezones on a given date. The results are ISO 8601 compatible string offsets like -0800 or +0530.", arguments: [ { name: "date", @@ -113,12 +113,12 @@ const fns: Record< { name: "tzA?", type: "string", - comment: "// default: UTC, ex: America/New_York", + comment: "default: UTC, ex: America/New_York", }, { name: "tzB?", type: "string", - comment: "// default: browser, ex: Europe/Paris", + comment: "default: browser, ex: Europe/Paris", }, ], return: "string", @@ -134,12 +134,12 @@ const fns: Record< { name: "locale", type: "string", - comment: '// default: "en"', + comment: 'default: "en"', }, { name: "genitive?", type: "boolean", - comment: "// default: false", + comment: "default: false", }, ], return: "string[]", diff --git a/docs/components/content/Format.vue b/docs/components/content/Format.vue index 709fdfb..4abb6ca 100644 --- a/docs/components/content/Format.vue +++ b/docs/components/content/Format.vue @@ -438,10 +438,11 @@ import { format } from "@formkit/tempo"

Part filter

- The partFilter option allows you to filter out parts of the - formatted date. The function is called with each "part" of the formatted - date and should return a boolean indicating whether or not to include that - part in final formatted string. + The partFilter option allows you to filter out + parts + of the formatted date. The function is called with each "part" of the + formatted date and should return a boolean indicating whether or not to + include that part in final formatted string.

Genitive case

diff --git a/docs/components/content/Parse.vue b/docs/components/content/Parse.vue index c6170c8..48a9b33 100644 --- a/docs/components/content/Parse.vue +++ b/docs/components/content/Parse.vue @@ -86,10 +86,11 @@ const parseOptionsProperties = [

partFilter

- The partFilter option gives you fine grained control over - which pieces and parts of a date you’d like to include in the resulting - Date object (remember, missing "parts" will default to the - today’s date at midnight local). + The partFilter option gives you fine-grained control over + which pieces and parts + of a date you’d like to include in the resulting Date object + (remember, missing "parts" will default to the today’s date at midnight + local).

dateOverflow

diff --git a/docs/examples/addDay.ts b/docs/examples/addDay.ts index 9386006..4ddcf8c 100644 --- a/docs/examples/addDay.ts +++ b/docs/examples/addDay.ts @@ -2,6 +2,7 @@ import { addDay } from "@formkit/tempo" // Add 1 day addDay("2013-03-15") + // Add 5 days addDay("2013-03-15", 5) diff --git a/docs/examples/parse-basic.ts b/docs/examples/parse-basic.ts index 517774e..abb5837 100644 --- a/docs/examples/parse-basic.ts +++ b/docs/examples/parse-basic.ts @@ -1,6 +1,6 @@ import { parse, format } from "@formkit/tempo" -// ISO8601 is the default a format +// ISO 8601 is the default format parse("1987-12-17") // Sample date formats diff --git a/docs/nuxt.config.ts b/docs/nuxt.config.ts index 8bfd438..3a98c61 100644 --- a/docs/nuxt.config.ts +++ b/docs/nuxt.config.ts @@ -69,7 +69,7 @@ export default defineNuxtConfig({ }, { name: "twitter:image", - content: "https://tempo.formkit.dev/og.png", + content: "https://tempo.formkit.com/og.png", }, ], }, diff --git a/src/dayOfYear.ts b/src/dayOfYear.ts index 019c120..9037ce1 100644 --- a/src/dayOfYear.ts +++ b/src/dayOfYear.ts @@ -3,7 +3,7 @@ import type { DateInput } from "./types" /** * Gets the what day of the year a given date is. For example, August 1st is - * the 213th day of the year on non-leapyears and 214th on leapyears. + * the 213th day of the year on non- years and 214th on leap years. * @param inputDate - The input date. */ export function dayOfYear(inputDate: DateInput): number {