differenceInCalendarISOWeekYears 関数って？2つの日付間のISO週番号年数の差をカンタンに計算する方法

date-fns の differenceInCalendarISOWeekYears 関数解説

differenceInCalendarISOWeekYears 関数は、2つの日付間のISO週番号年数の差を計算します。ISO週番号年数は、ISO 8601 規格で定義された年単位の期間で、1月4日から始まり、12月31日まで続きます。

使い方

import differenceInCalendarISOWeekYears from 'date-fns';

const date1 = new Date(2023, 11, 1); // 2023年12月1日
const date2 = new Date(2024, 2, 1); // 2024年3月1日

const difference = differenceInCalendarISOWeekYears(date1, date2);

console.log(difference); // 1

この例では、date1 は2023年12月1日、date2 は2024年3月1日です。differenceInCalendarISOWeekYears 関数は、これらの2つの日付間のISO週番号年数の差を計算し、1 を返します。

引数

• dateLeft: 比較対象となる最初の日付
• dateRight: 比較対象となる最後の日付

戻り値

2つの日付間のISO週番号年数の差

オプション

• weekStartsOn: 週の開始曜日を指定するオプション。デフォルトは月曜日です。

例

const difference = differenceInCalendarISOWeekYears(
  date1,
  date2,
  { weekStartsOn: 1 } // 週の開始曜日を日曜日に設定
);

この例では、週の開始曜日を日曜日に設定しています。

補足

• differenceInCalendarISOWeekYears 関数は、startOfWeek 関数と getISOWeekYear 関数を使用して内部的に実装されています。
• ISO週番号年数は、西暦年とは異なる場合があります。例えば、2023年12月31日はISO週番号年数2024に属します。

differenceInCalendarISOWeekYears 関数のサンプルコード

2つの日付間のISO週番号年数の差を計算する

import differenceInCalendarISOWeekYears from 'date-fns';

const date1 = new Date(2023, 11, 1); // 2023年12月1日
const date2 = new Date(2024, 2, 1); // 2024年3月1日

const difference = differenceInCalendarISOWeekYears(date1, date2);

console.log(difference); // 1

週の開始曜日を指定して、ISO週番号年数の差を計算する

import differenceInCalendarISOWeekYears from 'date-fns';

const date1 = new Date(2023, 11, 1); // 2023年12月1日
const date2 = new Date(2024, 2, 1); // 2024年3月1日

const difference = differenceInCalendarISOWeekYears(
  date1,
  date2,
  { weekStartsOn: 1 } // 週の開始曜日を日曜日に設定
);

console.log(difference); // 0

複数の期間のISO週番号年数の差を計算する

import differenceInCalendarISOWeekYears from 'date-fns';

const dates = [
  new Date(2023, 11, 1), // 2023年12月1日
  new Date(2024, 2, 1), // 2024年3月1日
  new Date(2024, 5, 1), // 2024年6月1日
  new Date(2024, 8, 1), // 2024年9月1日
];

const differences = dates.map((date, index) => {
  if (index === 0) {
    return 0;
  }

  return differenceInCalendarISOWeekYears(dates[index - 1], date);
});

console.log(differences); // [0, 1, 1, 1]

ISO週番号年数の差を文字列で取得する

import differenceInCalendarISOWeekYears from 'date-fns';
import format from 'date-fns/format';

const date1 = new Date(2023, 11, 1); // 2023年12月1日
const date2 = new Date(2024, 2, 1); // 2024年3月1日

const difference = differenceInCalendarISOWeekYears(date1, date2);

const formattedDifference = format(difference, 'y');

console.log(formattedDifference); // '1'

ISO週番号年数の差を複数言語で取得する

import differenceInCalendarISOWeekYears from 'date-fns';
import format from 'date-fns/format';
import { localize } from 'date-fns/locale';

const date1 = new Date(2023, 11, 1); // 2023年12月1日
const date2 = new Date(2024, 2, 1); // 2024年3月1日

const difference = differenceInCalendarISOWeekYears(date1, date2);

const enFormattedDifference = format(difference, 'y', { locale: localize.en });
const jaFormattedDifference = format(difference, 'y', { locale: localize.ja });

console.log(enFormattedDifference); // '1'
console.log(jaFormattedDifference); // '1年'

differenceInCalendarISOWeekYears 関数以外の方法

手計算

以下の手順で、手計算でISO週番号年数の差を計算できます。

1. 2つの日付それぞれのISO週番号年数を取得します。
2. 取得したISO週番号年数を比較して、差を計算します。

例

// 2023年12月1日のISO週番号年数
const isoWeekYear1 = getISOWeekYear(new Date(2023, 11, 1)); // 2024

// 2024年3月1日のISO週番号年数
const isoWeekYear2 = getISOWeekYear(new Date(2024, 2, 1)); // 2024

// ISO週番号年数の差
const difference = isoWeekYear2 - isoWeekYear1; // 0

ライブラリを使用する

date-fns 以外にも、Moment.js や Luxon などのライブラリを使用して、ISO週番号年数の差を計算することができます。

Moment.js の例

import moment from 'moment';

const date1 = moment(new Date(2023, 11, 1));
const date2 = moment(new Date(2024, 2, 1));

const difference = date2.isoWeekYear() - date1.isoWeekYear();

console.log(difference); // 0

Luxon の例

import { DateTime } from 'luxon';

const date1 = DateTime.fromJSDate(new Date(2023, 11, 1));
const date2 = DateTime.fromJSDate(new Date(2024, 2, 1));

const difference = date2.weekYear - date1.weekYear;

console.log(difference); // 0

• 簡単な計算であれば、手計算で十分です。
• 複雑な計算や、他のライブラリとの連携が必要であれば、date-fns などのライブラリを使用するのがおすすめです。
• Moment.js や Luxon などのライブラリは、date-fns 以外にも様々な機能を提供しているので、これらのライブラリを既に使用している場合は、これらのライブラリを使用してISO週番号年数の差を計算することもできます。

differenceInCalendarISOWeekYears 関数は、2つの日付間のISO週番号年数の差を計算する便利な関数です。

上記で紹介した他の方法も参考にして、状況に応じて適切な方法を選択してください。