@time-provider/plugin-moment

Time-Provider ~ Moment.js plugin

Description

This is the Moment.js plugin for Time-Provider.

Usage

import { createTimeProvider } from "@time-provider/core";
import { createTimeProvider as createDeterministicTimeProvider } from "@time-provider/core/deterministic";
import { plugin } from "@time-provider/plugin-moment";
import { plugin as deterministicPlugin } from "@time-provider/plugin-moment/deterministic";

// System: real clock and timers. This plugin is UTC-only.
const timeProvider = createTimeProvider.for(plugin).create();
timeProvider.clock.utcNow(); // a Moment.js Moment

// Deterministic: a simulated clock that only moves when you advance it.
using manual = createDeterministicTimeProvider
  .for(deterministicPlugin)
  .asManual()
  .withInitialTime("2026-01-01T00:00:00.000Z")
  .create();
manual.clock.advance({ hours: 1 });
manual.clock.utcNow(); // 2026-01-01T01:00:00.000Z

Notes

When used without the Moment-Timezone extension, Moment.js does not provide support for IANA time zones or daylight saving time (DST)-aware time zone conversions.

As a result, Time-Provider intentionally does not expose time zone or local-time APIs for Moment.
This plugin provides a UTC-only facade.

If you need true local time or first-class time zone support, consider extending Moment.js with Moment-Timezone and using the Time-Provider Moment-Timezone plugin.

Changelog

See CHANGELOG.md