Skip to content

createNotificationRelay — @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 { createNotificationRelay } from '@gj-kit/nest-notifications/core';
/**
* Builds the relay stage of the pipeline.
*
* One pass claims a page of due ingress rows, materialises each into a delivery
* inside the store's own transaction, and stamps completion. It is safe to run
* concurrently on many workers: every safety property comes from the store's
* atomicity obligations (R1-R13) rather than from this code.
*
* A periodic runner owns correctness. `relayDue()` is what a scheduler calls;
* the wakeup hint is only a latency optimisation (design 0.3-1).
*/
declare function createNotificationRelay(options: NotificationRelayOptions): NotificationRelay;

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