Skip to content

notificationRecipientKey — @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.

import { notificationRecipientKey } from '@gj-kit/nest-notifications/core';
/**
* Stable opaque key for the recipient liveness barrier. The digest is
* byte-identical to `sha256(applicationKey + U+0000 + recipientRef)`, so a host
* that already stores tombstones under the source's key needs no migration.
*
* Throws `ERR_NOTIFICATION_RECIPIENT_KEY_INPUT` when either input contains a
* U+0000 code point: the separator is only injective while the inputs are free
* of it, and a length-prefixed encoding would have changed the digest (design
* 0.2-5).
*
* The caller is the host, not the pipeline: a
* {@link ../core/lifecycle!NotificationRecipientLiveness} implementation uses it
* as the tombstone row key, which lets the barrier outlive a purge without
* retaining the raw recipient reference.
*/
declare function notificationRecipientKey(applicationKey: string, recipientRef: string): string;

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