【超便利！】date-fnsのMinute Helpersで分を操る！isThisMinute関数の実践的な使い方

date-fns の Minute Helpers と isThisMinute 関数

isThisMinute 関数は、Minute Helpers の一つで、現在時刻が指定された分かどうかを判断します。

isThisMinute 関数の使い方

import isThisMinute from 'date-fns/isThisMinute';

// 現在時刻が 12:30 かどうかを判断
const isThisMinute1230 = isThisMinute(new Date(), 30);

// 現在時刻が 13:00 かどうかを判断
const isThisMinute1300 = isThisMinute(new Date(), 0);

console.log(isThisMinute1230); // true
console.log(isThisMinute1300); // false

上記の例では、isThisMinute 関数に現在時刻と比較したい分を渡しています。

• isThisMinute1230 は、現在時刻が 12:30 かどうかを判断します。

isThisMinute 関数は、オプションで以下のパラメータを渡すことができます。

• locale: 使用するロケールを指定します。デフォルトは 'en-US' です。
• weekStartsOn: 週の始まりを指定します。デフォルトは '0' (日曜日) です。

// 日本語ロケールで、現在時刻が 12:30 かどうかを判断
const isThisMinute1230Ja = isThisMinute(new Date(), 30, {
  locale: 'ja-JP',
});

// 週の始まりを月曜日に設定して、現在時刻が 13:00 かどうかを判断
const isThisMinute1300Mon = isThisMinute(new Date(), 0, {
  weekStartsOn: 1,
});

isThisMinute 関数は、以下のようなユースケースで利用できます。

• 特定の時間に何かを実行する
• 特定の時間の範囲内に何かを実行する
• 特定の時間の経過を監視する

例：特定の時間にアラームを設定する

import isThisMinute from 'date-fns/isThisMinute';

const alarmTime = new Date(2023, 11, 1, 12, 30);

setInterval(() => {
  if (isThisMinute(new Date(), alarmTime.getMinutes())) {
    // アラームを鳴らす
  }
}, 1000);

上記の例では、isThisMinute 関数を使用して、12:30 にアラームを鳴らすプログラムを作成しています。

isThisMinute 関数は、現在時刻が指定された分かどうかを判断するための便利な関数です。

Minute Helpers を利用することで、JavaScript で日付と時刻を扱う様々な操作を簡単に行うことができます。

isThisMinute 関数のサンプルコード

特定の時間に何かを実行する

import isThisMinute from 'date-fns/isThisMinute';

const startTime = new Date(2023, 11, 1, 10, 0);
const endTime = new Date(2023, 11, 1, 11, 0);

setInterval(() => {
  const now = new Date();
  if (isThisMinute(now, startTime.getMinutes())) {
    // 作業開始
  } else if (isThisMinute(now, endTime.getMinutes())) {
    // 作業終了
  }
}, 1000);

特定時間の範囲内に何かを実行する

import isThisMinute from 'date-fns/isThisMinute';

const startHour = 9;
const endHour = 18;

setInterval(() => {
  const now = new Date();
  const hour = now.getHours();
  const minute = now.getMinutes();

  if (isThisMinute(now, 0) && hour >= startHour && hour < endHour) {
    // 業務開始
  } else if (isThisMinute(now, 59) && hour >= startHour && hour < endHour) {
    // 業務終了
  }
}, 1000);

上記の例では、isThisMinute 関数を使用して、9:00 から 18:00 までの間だけ業務を行うプログラムを作成しています。

特定時間の経過を監視する

import isThisMinute from 'date-fns/isThisMinute';

const startTime = new Date();

setInterval(() => {
  const now = new Date();
  const elapsedMinutes = Math.floor((now - startTime) / 60000);

  if (isThisMinute(now, 0)) {
    console.log(`経過時間: ${elapsedMinutes}分`);
  }
}, 1000);

上記の例では、isThisMinute 関数を使用して、プログラム実行開始からの経過時間を分単位で表示するプログラムを作成しています。

その他の Minute Helpers 関数

• isPreviousMinute: 現在時刻が指定された分よりも前かどうかを判断します。
• isSameMinute: 現在時刻と指定された時刻が同じ分かどうかを判断します。
• getMinutes: 日付オブジェクトから分を取得します。
• addMinutes: 日付オブジェクトに指定された分を加算します。

これらの関数も、isThisMinute 関数と同様に、様々なユースケースで利用できます。

isThisMinute 関数以外の方法

Date オブジェクトの getMinutes() メソッド

const now = new Date();
const minute = now.getMinutes();

if (minute === 30) {
  // 現在時刻は 30 分です
}

上記の例では、getMinutes() メソッドを使用して、現在時刻の分を取得しています。

Date オブジェクトのtoLocaleTimeString() メソッド

const now = new Date();
const timeString = now.toLocaleTimeString();

if (timeString === '12:30:00') {
  // 現在時刻は 12:30 です
}

上記の例では、toLocaleTimeString() メソッドを使用して、現在時刻を文字列に変換しています。

Moment.js ライブラリを使用すると、より柔軟に日付と時刻を扱うことができます。

import moment from 'moment';

const now = moment();

if (now.minute() === 30) {
  // 現在時刻は 30 分です
}

上記の例では、Moment.js ライブラリの minute() メソッドを使用して、現在時刻の分を取得しています。

これらの方法は、isThisMinute 関数よりもシンプルですが、機能が限定されます。

• シンプルな方法で現在時刻の分を取得したい場合は、getMinutes() メソッドを使うのがおすすめです。
• 現在時刻を文字列で比較したい場合は、toLocaleTimeString() メソッドを使うのがおすすめです。
• より柔軟に日付と時刻を扱いたい場合は、Moment.js ライブラリを使うのがおすすめです。

isThisMinute 関数は、これらの方法よりも機能が豊富ですが、コードが複雑になるというデメリットがあります。

• isThisMinute 関数は、現在時刻が特定の分かどうかを判断するための便利な関数です。
• 他の方法としては、getMinutes() メソッド、toLocaleTimeString() メソッド、Moment.js ライブラリなどがあります。
• どの方法を使うべきかは、状況によって異なります。