# get-formatted-date

> Get formatted date with zero dependencies!

Latest version **1.0.3** (published 2021-08-21) · ISC license · 0 weekly downloads

## Install

```sh
npm install get-formatted-date
pnpm add get-formatted-date
yarn add get-formatted-date
bun add get-formatted-date
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-08-21 |
| First published | 2021-08-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Yilmaz Oktav |
| Maintainers | yoktav |
| Keywords | get, date, js, time, string, timestamp, value, utc, simple |

## Links

- npm: https://www.npmjs.com/package/get-formatted-date
- Repository: https://github.com/yoktav/get-formatted-date
- Homepage: https://github.com/yoktav/get-formatted-date#readme
- Issues: https://github.com/yoktav/get-formatted-date/issues
- npm.io page: https://npm.io/package/get-formatted-date

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.3 (latest) — 2021-08-21
- 1.0.2 — 2021-08-18
- 1.0.0 — 2021-08-18

## README

# Get Formatted Date

[![NPM version](https://img.shields.io/npm/v/get-formatted-date.svg?style=flat)](https://www.npmjs.com/package/get-formatted-date)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
[![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)

Get formatted date with zero dependencies!

## Installation
```bash
# With yarn
$ yarn add get-formatted-date

# With npm
$ npm i get-formatted-date
```

## Which Functions Included ?
- `getDate()`
- `getYesterday()`
- `getTomorrow()`

## Example Usage

### Basic Usage
```javascript
import { getDate, getYesterday, getTomorrow } from 'get-formatted-date';

const myDate = new Date() // Let's say new Date() is 05.01.2021 - 11:00

getDate({ date: myDate }); // Returns 05.08.2021
getYesterday({ date: myDate }); // Returns 04.08.2021
getTomorrow({ date: myDate }); // Returns 06.08.2021
```

### Detailed Usage
```javascript
import { getDate, getYesterday, getTomorrow } from 'get-formatted-date';

const myDate = new Date() // Let's say new Date() is 05.01.2021 - 11:00

getDate({ date: myDate, seperator: '/', hasHM: true, timeSeperator: '-', HMSeperator: '.' }); // Returns 05/01/2021 - 11.00
getYesterday({ date: myDate, seperator: '/', hasHM: true, timeSeperator: '-', HMSeperator: '.' }); // Returns 04/01/2021 - 11.00
getTomorrow({ date: myDate, seperator: '/', hasHM: true, timeSeperator: '-', HMSeperator: '.' }); // Returns 06/01/2021 - 11.00
```

## Options
| Params | Type | Description |
| --- | --- | --- |
| `date` | Time value \| Timestamp \| Timestamp String |  Default: new Date() <br /> For more info see [this MDN document](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date) |
| `seperator` | String | Default: `'.'` <br /> Seperator between dates |
| `hasHM` | Boolean | Default: false <br /> Whether include Hour and Minute |
| `timeSeperator` | String | Default: `'-'` <br /> Seperator for date and time |
| `HMSeperator` | String | Default: `':'` <br /> Seperator for hour and minute |


## Todo
- [x] Create the code!
- [X] Make a NPM Package
- [ ] Configure for cdn usage
- [ ] Add DDMMYYYY etc. support
- [ ] Add webpack | Gulp | Rollup


## Contributing
If you've ever wanted to contribute to open source, and a great cause, now is your chance!

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