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

Verified import example

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

Signature, parameters, and return type

interface NotificationDispatcherOptions {
    readonly applicationKey: string;
    readonly store: NotificationDeliveryStore;
    readonly endpoints: NotificationEndpointStore;
    readonly pushGateway: NotificationPushGateway;
    readonly presenter: NotificationPresenter;
    /** Which endpoint providers this gateway handles. Required: no default provider. */
    readonly providers: readonly string[];
    readonly runtime?: NotificationRuntime | undefined;
    readonly logger?: NotificationLogger | undefined;
    /** Defaults to {@link DEFAULT_DISPATCH_PAGE_SIZE}. */
    readonly pageSize?: number | undefined;
    /** A duration; the store compares it against its own clock (D8). */
    readonly claimStaleMs?: number | undefined;
    /**
     * Deliveries already attempted this many times are left out of the page (D9).
     * Same trade-off, same arithmetic and the same silence as
     * `NotificationRelayOptions.maxAttempts` - read that one. The dispatch
     * side loses less on exhaustion (the inbox message is already written, so only
     * the push is lost), but the push is lost for good.
     */
    readonly maxAttempts?: number | undefined;
    /**
     * Disable locally rejected endpoints too. Default false: a local shape check is
     * not a provider confirmation, and the day our check becomes stricter than the
     * provider's it would permanently darken live devices (design 0.2-6).
     */
    readonly disableRejectedEndpoints?: boolean | 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: ./core
• Source: GitHub