Skip to content
GJ Kit

NotificationDispatchSummary — @gj-kit/nest-notifications

A public type from @gj-kit/nest-notifications. The signature below is taken directly from the 0.1.1 release declaration.

Verified import example

Section titled “Verified import example”
import { NotificationDispatchSummary } from '@gj-kit/nest-notifications';

Signature, parameters, and return type

Section titled “Signature, parameters, and return type”
/** A type alias for the same reason `NotificationRelaySummary` is (design 3.6). */
type NotificationDispatchSummary = {
    readonly ok: boolean;
    readonly claimed: number;
    readonly delivered: number;
    readonly failed: number;
    /**
     * Endpoints this pass asked the store to disable. `disable` returns void, so a
     * revision that no longer matches is counted here even though the store made
     * it a no-op (D6). It is a request count, not a row count.
     */
    readonly endpointsDisabled: 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.

Release context

Section titled “Release context”
  • Package: @gj-kit/nest-notifications
  • Version: 0.1.1
  • Public entry: .
  • Source: GitHub