createQuietHoursPolicy — @gj-kit/nest-notifications

A public function from @gj-kit/nest-notifications/core. The signature below is taken directly from the 0.1.1 release declaration.

Verified import example

import { createQuietHoursPolicy } from '@gj-kit/nest-notifications/core';

Signature, parameters, and return type

/**
 * Single-zone quiet-hours policy.
 *
 * Every decision is wall-clock arithmetic over an IANA zone, so a DST boundary
 * or a non-hourly offset such as +05:45 stays correct. Three interpretation
 * rules are part of the contract (design 3.2.3):
 *
 * 1. A release instant that does not exist (spring-forward gap) releases at the
 *    first instant after the gap.
 * 2. A release instant that exists twice (autumn fall-back) releases at the
 *    earlier one.
 * 3. A computed release at or before `now` advances a day and recomputes; with
 *    no valid solution inside 48 hours it delivers immediately, because an
 *    unbounded hold is indistinguishable from a lost notification.
 *
 * Assembly-time validation throws `ERR_NOTIFICATION_TIMEZONE_INVALID` or
 * `ERR_NOTIFICATION_POLICY_INVALID`, so a misconfigured deployment fails to boot
 * rather than mis-delivering quietly.
 */
declare function createQuietHoursPolicy(options: QuietHoursPolicyOptions): NotificationSchedulingPolicy;

This declaration is the source of truth for parameters, optionality, generics, return values, and public union/type contracts. Check the package golden path and this subpath’s import conditions for required environment, permission, and error boundaries before calling it.

Release context

• Package: @gj-kit/nest-notifications
• Version: 0.1.1
• Public entry: ./core
• Source: GitHub