chore: add example

frytg · Dec 12, 2024 · d3f1d8b · d3f1d8b
1 parent 63f7e39
commit d3f1d8b
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/dates/dates.ts b/dates/dates.ts
@@ -206,5 +206,16 @@ export const getFullRelativeTime = (date: DateTime): string => `${getDateHourMin
  *
  * @param {number} duration - the duration in milliseconds
  * @returns {string} the formatted duration (e.g. `1m 39s`)
+ *
+ * @example
+ * ```ts
+ * import { formatDuration } from 'jsr:@frytg/dates'
+ *
+ * formatDuration(1000) // 1s
+ *
+ * const startTs = getMs()
+ * // do something...
+ * formatDuration(getMsOffset(startTs)) // time taken
+ * ```
  */
 export const formatDuration = (duration: number) => stdFormat(duration, { ignoreZero: true })