Skip to content

ClaimedNotificationCommand — @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 { ClaimedNotificationCommand } from '@gj-kit/nest-notifications/core';
interface ClaimedNotificationCommand {
readonly id: string;
readonly applicationKey: string;
readonly recipientRef: string;
readonly actorRef: string | null;
readonly targetRef: string | null;
readonly category: string;
/** A plain string: narrow it with `notificationPriorityFrom`. */
readonly priority: string;
readonly title: string | null;
readonly body: string;
readonly action: NotificationAction | null;
readonly eventKey: string;
readonly batchKey: string | null;
readonly batchLabel: string | null;
readonly batchItemCount: number;
readonly timing: NotificationTiming;
/**
* When this row entered the ingress outbox. The library never writes it: it has
* no staging method (staging belongs to the host's `NotificationPublisher`), so
* this timestamp comes from the host's staging path (R13). It is also the input
* to the batch bucket, which is why R13 makes it an obligation rather than a
* field description.
*/
readonly createdAt: Date;
/** How many times a worker has claimed this row, including this claim (R13). */
readonly attempts: number;
}

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