# @sensethenlove/get-relative-time

> Simple function that recieves a date and gives back the relative time using Intl.RelativeTimeFormat('en', { numeric: 'auto' })

Latest version **1.0.0** (published 2023-05-04) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @sensethenlove/get-relative-time
pnpm add @sensethenlove/get-relative-time
yarn add @sensethenlove/get-relative-time
bun add @sensethenlove/get-relative-time
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-05-04 |
| First published | 2023-05-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 42 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Sense Then Love |
| Maintainers | sensethenlove |
| Keywords | Intl, RelativeTimeFormat, moment, date, relative, ago, past, future, till, time, typescript |

## Links

- npm: https://www.npmjs.com/package/@sensethenlove/get-relative-time
- Repository: https://github.com/sensethenlove/get-relative-time
- Homepage: https://github.com/sensethenlove/get-relative-time#readme
- Issues: https://github.com/sensethenlove/get-relative-time/issues
- npm.io page: https://npm.io/package/@sensethenlove/get-relative-time

## Alternatives

- [@js-joda/timezone](https://npm.io/package/@js-joda/timezone.md) — 383.4K weekly downloads
- [chartjs-adapter-moment](https://npm.io/package/chartjs-adapter-moment.md) — 210.8K weekly downloads
- [strftime](https://npm.io/package/strftime.md) — 171.2K weekly downloads
- [vue-flatpickr-component](https://npm.io/package/vue-flatpickr-component.md) — 115.8K weekly downloads
- [timepicker](https://npm.io/package/timepicker.md) — 51.0K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-05-04

## README

# 🕉 @sensethenlove/get-relative-time


### 🙏 Description
Simple function that recieves a date and gives back the relative time using `Intl.RelativeTimeFormat('en', { numeric: 'auto' })`


### ☯️ Install
```bash
pnpm add @sensethenlove/get-relative-time
```

### 💛 Example
```ts
import { getRelativeTime } from '@sensethenlove/get-relative-time'

getRelativeTime(new Date()) // now
getRelativeTime(new Date('2023-05-05')) // tomorrow
getRelativeTime(new Date('1991-04-08')) // 32 years ago
```


### 🧡 Supports
* Seconds
* Minutes
* Hours
* Days
* Weeks
* Months
* Years


### 💖 Our helpful packages!
* [@sensethenlove/jwt](https://www.npmjs.com/package/@sensethenlove/jwt)
* [@sensethenlove/slug](https://www.npmjs.com/package/@sensethenlove/slug)
* [@sensethenlove/toast](https://www.npmjs.com/package/@sensethenlove/toast)
* [@sensethenlove/env-write](https://www.npmjs.com/package/@sensethenlove/env-write)
* [@sensethenlove/svelte-modal](https://www.npmjs.com/package/@sensethenlove/svelte-modal)
* [@sensethenlove/global-style](https://www.npmjs.com/package/@sensethenlove/global-style)
* [@sensethenlove/get-form-entries](https://www.npmjs.com/package/@sensethenlove/get-form-entries)
* [@sensethenlove/svelte-turnstile](https://www.npmjs.com/package/@sensethenlove/svelte-turnstile)
* [@sensethenlove/svelte-loading-anchor](https://www.npmjs.com/package/@sensethenlove/svelte-loading-anchor)

---
_Source: https://npm.io/package/@sensethenlove/get-relative-time · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._