README.md

Date Utilities

Date Range utility

microCMS API returns the date and time in UTC as the timezone.
If you want to retrieve a date or time in Japan time, you have to convert it to UTC each time.
microcms-utils date utility provides functions to make working with the API easier.

getAbsoluteTime

You can get the date and time independent of the time zone of the execution environment.

import { getAbsoluteTime } from 'microcms-utils'

// Local time dependent on execution environment is displayed. ex. UTC Runtime
const dateTime = new Date().toISOString().toLocaleString();
// 2023-06-01T01:14:53.838Z

// Local time in the specified time difference is displayed. ex. display JST on UTC or the other timezone Runtime
const absoluteDateTime = getAbsoluteTime(new Date().toISOString(), 9).toLocaleString();
// 2023/6/1 10:14:53

getStartAndEndOfTime

You can get the start and end ISO strings of a specific day or a range of days or months, adjusted for timezone offset.

day

import { getStartAndEndOfTime } from 'microcms-utils';

const [start, end] = getStartAndEndOfTime('2023-05-01');

// start: 2023-04-30T14:59:59.999Z
// end: 2023-05-01T15:00:00.000Z

// range option
const [start, end] = getStartAndEndOfTime('2023-06-01', {
  range: 3, // 3 days
}),

// start: 2023-05-29T14:59:59.999Z
// end: 2023-06-01T15:00:00.000Z

month

import { getStartAndEndOfTime } from 'microcms-utils';

const [start, end] = getStartAndEndOfTime('2023-05');

// start: 2023-04-30T14:59:59.999Z
// end: 2023-05-31T15:00:00.000Z

// range option
const [start, end] = getStartAndEndOfTime('2023-06', {
  range: 3, // 3 months
}),

// start: 2023-03-31T14:59:59.999Z
// end: 2023-06-30T15:00:00.000Z

year

import { getStartAndEndOfTime } from 'microcms-utils';

const [start, end] = getStartAndEndOfTime('2023');

// start: 2022-12-31T14:59:59.999Z
// end: 2023-12-31T15:00:00.000Z

// range option
const [start, end] = getStartAndEndOfTime('2023', {
  range: 3, // 3 years
}),

// start: 2020-12-31T14:59:59.999Z
// end: 2023-12-31T15:00:00.000Z

getFormattedFilterTimeRange

You can get a formatted filter time range string for a specific field and a day or range of days or months.

import { getFormattedFilterTimeRange } from 'microcms-utils';

const queryString = getFormattedFilterTimeRange('created_at', '2023-05');

// created_at[greater_than]2023-04-30T14:59:59.999Z[and]created_at[less_than]2023-05-31T15:00:00.000Z

const rangedQueryString = getFormattedFilterTimeRange('created_at', '2023-06', {
  range: 2, // 2 months
});

// created_at[greater_than]2023-04-30T14:59:59.999Z[and]created_at[less_than]2023-06-30T15:00:00.000Z