Skip to content

QuietHoursPolicyOptions — @gj-kit/nest-notifications

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

import { QuietHoursPolicyOptions } from '@gj-kit/nest-notifications';
interface QuietHoursPolicyOptions {
/**
* IANA time zone name (for example `'Europe/Paris'`), or `'UTC'`.
* The library holds no regional default: this field is required.
*/
readonly timeZone: string;
/** `null` disables quiet hours entirely. */
readonly quietHours?: NotificationQuietHours | null | undefined;
/** Aggregation window length. Must divide 24h evenly. Defaults to {@link DEFAULT_BATCH_WINDOW_MS}. */
readonly batchWindowMs?: number | undefined;
/** Priorities held during quiet hours. Defaults to `['NORMAL']`. */
readonly holdPriorities?: readonly NotificationPriority[] | undefined;
}

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.

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