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

Verified import example

import { NestNotificationsOptions } from '@gj-kit/nest-notifications';

Signature, parameters, and return type

interface NestNotificationsOptions {
    readonly applicationKey: string;
    readonly relayStore: NotificationRelayStore;
    readonly deliveryStore: NotificationDeliveryStore;
    readonly endpointStore: NotificationEndpointStore;
    readonly pushGateway: NotificationPushGateway;
    readonly presenter: NotificationPresenter;
    readonly policy: NotificationSchedulingPolicy;
    /** Which endpoint providers the gateway handles. Must be non-empty. */
    readonly providers: readonly string[];
    /**
     * Exposed through `NOTIFICATION_PUBLISHER` for source-domain code. The pipeline
     * never calls it: staging happens in the host's own transaction.
     */
    readonly publisher?: NotificationPublisher<never> | undefined;
    readonly logger?: NotificationLogger | undefined;
    /**
     * Shared by the relay, the dispatcher and the wakeup hint - one instance, not
     * three. Defaults to `systemNotificationRuntime()`. Without this a consumer
     * wired through `forRoot` cannot fix the clock, so their own quiet-hours and
     * batch-window behaviour is untestable, and `defer` cannot be swapped for a
     * serverless host (design 0.2-12).
     */
    readonly runtime?: NotificationRuntime | undefined;
    readonly wakeup?: {
        readonly enabled?: boolean | undefined;
    } | undefined;
    readonly relay?: Pick<NotificationRelayOptions, 'pageSize' | 'claimStaleMs' | 'maxAttempts'> | undefined;
    readonly dispatch?: Pick<NotificationDispatcherOptions, 'pageSize' | 'claimStaleMs' | 'maxAttempts' | 'disableRejectedEndpoints'> | 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.

Release context

• Package: @gj-kit/nest-notifications
• Version: 0.1.1
• Public entry: .
• Source: GitHub