Skip to content

NotificationCommand — @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 { NotificationCommand } from '@gj-kit/nest-notifications';
/**
* One source recipient plus one stable event key is the idempotency boundary
* (design 3.1 G1). `applicationKey` is server-owned configuration: API callers
* must never choose it.
*
* Delivery order between two commands is never guaranteed (G8). Quiet-hours
* holds, batch windows, scheduled timings, parallel workers and per-item retries
* all reorder deliveries, so a domain that needs an order must put it in the
* body.
*/
interface NotificationCommand {
readonly applicationKey: string;
readonly recipientRef: string;
readonly actorRef?: string | null | undefined;
readonly targetRef?: string | null | undefined;
readonly category: string;
readonly priority: NotificationPriority;
readonly title?: string | null | undefined;
readonly body: string;
readonly action?: NotificationAction | null | undefined;
readonly eventKey: string;
readonly batch?: NotificationBatch | null | undefined;
readonly timing?: NotificationTiming | 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