Skip to content

Latest commit

 

History

History
73 lines (57 loc) · 4.51 KB

README.md

File metadata and controls

73 lines (57 loc) · 4.51 KB
Raw

🕉 @feelinglovelynow/get-relative-time

💎 Install

pnpm add @feelinglovelynow/get-relative-time

🤓 Unit Tests

Statements

🙏 Description

  • Simple function that recieves a Date object that is in the future or is in the past and gives back the relative time using Intl.RelativeTimeFormat('en', { numeric: 'auto' })
  • Examples: [ "last year", "6 months ago", "4 weeks ago", "7 days ago", "now", "in 1 minute", "in 6 hours", "tomorrow", "in 3 days", "in 4 weeks", "next month", "in 2 months", "in 12 months", "next year" ]

💚 Examples

import { getRelativeTime } from '@feelinglovelynow/get-relative-time'

const d1 = new Date()
d1.setDate(d1.getDate() - 450)
getRelativeTime(d1) // last year

const d2 = new Date()
d2.setDate(d2.getDate() - 180)
getRelativeTime(d2) // 6 months ago

const d3 = new Date()
d3.setDate(d3.getDate() - 30)
getRelativeTime(d3) // 4 weeks ago

const d4 = new Date()
d4.setDate(d4.getDate() - 7)
getRelativeTime(d4) // 7 days ago

getRelativeTime(new Date()) // now
getRelativeTime(new Date((new Date()).getTime() + 60000)) // in 1 minute
getRelativeTime(new Date((new Date()).getTime() + 360 * 60000)) // in 6 hours
getRelativeTime(new Date((new Date()).getTime() + (1440 * 60000))) // tomorrow
getRelativeTime(new Date((new Date()).getTime() + (3 * 1440 * 60000))) // in 3 days
getRelativeTime(new Date((new Date()).getTime() + (28 * 1440 * 60000))) // in 4 weeks
getRelativeTime(new Date((new Date()).getTime() + (35 * 1440 * 60000))) // next month
getRelativeTime(new Date((new Date()).getTime() + (60 * 1440 * 60000))) // in 2 months
getRelativeTime(new Date((new Date()).getTime() + (365 * 1440 * 60000))) // in 12 months
getRelativeTime(new Date((new Date()).getTime() + (400 * 1440 * 60000))) // next year

🔥 Errors we may throw

  • getRelativeTime()
if (!(date instanceof Date) || date.toString() === 'Invalid Date') throw { id: 'fln__get-relative-time__invalid-date', message: 'Please pass getRelativeTime() a valid date object', _errorData: { date } }

🎁 All Our Packages

  1. @feelinglovelynow/datetime-local: NPM ⋅ Github
  2. @feelinglovelynow/dgraph: NPM ⋅ Github
  3. @feelinglovelynow/env-write: NPM ⋅ Github
  4. @feelinglovelynow/get-form-entries: NPM ⋅ Github
  5. @feelinglovelynow/get-relative-time: NPM ⋅ Github
  6. @feelinglovelynow/global-style: NPM ⋅ Github
  7. @feelinglovelynow/jwt: NPM ⋅ Github
  8. @feelinglovelynow/loop-backwards: NPM ⋅ Github
  9. @feelinglovelynow/slug: NPM ⋅ Github
  10. @feelinglovelynow/svelte-catch: NPM ⋅ Github
  11. @feelinglovelynow/svelte-kv: NPM ⋅ Github
  12. @feelinglovelynow/svelte-loading-anchor: NPM ⋅ Github
  13. @feelinglovelynow/svelte-modal: NPM ⋅ Github
  14. @feelinglovelynow/svelte-turnstile: NPM ⋅ Github
  15. @feelinglovelynow/toast: NPM ⋅ Github