# @date-fns/upgrade

> A tool for upgrading date-fns versions

Latest version **1.0.3** (published 2020-04-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @date-fns/upgrade
pnpm add @date-fns/upgrade
yarn add @date-fns/upgrade
bun add @date-fns/upgrade
```

## 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 | 2020-04-04 |
| First published | 2019-08-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 24.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Sasha Koss |
| Maintainers | d_kozickis, kossnocorp, leshakoss |

## Links

- npm: https://www.npmjs.com/package/@date-fns/upgrade
- Repository: https://github.com/date-fns/date-fns-upgrade
- Homepage: https://github.com/date-fns/date-fns-upgrade#readme
- Issues: https://github.com/date-fns/date-fns-upgrade/issues
- npm.io page: https://npm.io/package/@date-fns/upgrade

## Dependencies (1)

- [date-fns](https://npm.io/package/date-fns.md) ^2.1

## Recent versions

- 1.0.3 (latest) — 2020-04-04
- 1.0.2 — 2020-04-04
- 1.0.1 — 2019-09-11
- 1.0.0-beta.2 — 2019-08-22
- 1.0.0-beta.1 — 2019-08-13

## README

# date-fns upgrade

Support package with helper functions for `date-fns` upgrade from `1.x` to `2.x`

Codemod that will help you apply these helpers automatically located here -
[date-fns-upgrade-codemod](https://github.com/date-fns/date-fns-upgrade-codemod).

## Installation

```bash
npm install @date-fns/upgrade --save
# or with yarn
yarn add @date-fns/upgrade
```

## Usage

### convertTokens

`convertTokens` is a helper function used for 2nd argument of `format` function
to convert date tokens like `YYYY` to new format.
See [this post](https://blog.date-fns.org/post/unicode-tokens-in-date-fns-v2-sreatyki91jg)
for more details.

```diff
+import { convertTokens } from '@date-fns/upgrade/v2'

const formattedDate = format(
  new Date(),
- 'YYYY',
+ convertTokens('YYYY'),
)
```

### legacyParse

`date-fns@2.x` functions don't accept string as arguments any more (see [CHANGELOG](https://github.com/date-fns/date-fns/blob/master/CHANGELOG.md#changed)), `legacyParse` is used to simplify that transition, it uses algorithm from `1.x` to do that. See [this post](https://blog.date-fns.org/post/we-cut-date-fns-v2-minimal-build-size-down-to-300-bytes-and-now-its-the-smallest-date-library-18f2nvh2z0yal) for details on "why" this was done.

```diff
+import { legacyParse } from '@date-fns/upgrade/v2'

const formattedDate = format(
- '2014',
+ legacyParse('2014'),
  'YYYY',
)
```

### legacyParseMap

`legacyParseMap` is used same as `legacyParse` but for arguments that accept arrays.

```diff
+import { legacyParseMap } from '@date-fns/upgrade/v2'

var dateToCompare = new Date(2015, 8, 6)
var datesArray = [
  '2014-01-01',
  '2015-01-01'
]
-var result = closestIndexTo(dateToCompare, datesArray)
+var result = closestIndexTo(dateToCompare, legacyParseMap(datesArray))
```

## License

[MIT © Sasha Koss](https://kossnocorp.mit-license.org/)

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