Skip to content

NotificationPushPayload — @gj-kit/nest-notifications

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

import { NotificationPushPayload } from '@gj-kit/nest-notifications/core';
interface NotificationPushPayload {
/** The durable inbox message id. */
readonly notificationId: string;
/**
* Stable across every retry of this delivery. Transports that support
* de-duplication or collapsing should map it onto their own key: retries are
* at-least-once (design 3.1 G5), and this is the only lever that reduces
* duplicates.
*/
readonly idempotencyKey: string;
readonly collapseKey?: string | undefined;
readonly recipientRef: string;
readonly title: string | null;
readonly body: string;
readonly action: NotificationAction | null;
readonly priority: NotificationPriority;
}

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: ./core
  • Source: GitHub