README.md

dayjs-jp-era

目的

dayjsのformatにて日本の元号を表示するプラグインです。
https://github.com/hyakt/dayjs-jp-format さんをフォークしてます。
理由：平成30年のときに「平成30」、令和4年のとき「令和4年」と表記されてしまっていたため。

Usage

1. Install the repository

npm install --save dayjs-jp-format
npm install --save dayjs # peer dependency

or

yarn add dayjs-jp-format
yarn add dayjs # peer dependency

2. Import the jp format

import { jpFormat } from 'dayjs-jp-era'
dayjs.extend(jpFormat) // use plugin

const date = '2020-06-24'
const result = dayjs(date).format('rrrr')
console.log(result); //-> 令和2

const result = dayjs(date).format('rrrr年')
console.log(result); //-> 令和2年

const result = dayjs(date).format('rrr')
console.log(result); //-> 令和2年

const result = dayjs(date).format('rr')
console.log(result); //-> 令和

Format

Format	Output	Description
rrrr	令和2	日付に応じた和暦(年は除く)
rrr	令和2年	年あり
rr	令和	日付に応じた元号