NotificationRelaySummary — @gj-kit/nest-notifications

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

Verified import example

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

Signature, parameters, and return type

/**
 * Declared as a type alias, NOT an interface. Only object type aliases get an
 * implicit index signature, so only this form is assignable to
 * `Record<string, unknown>` - which is exactly the shape a sibling job runner's
 * summary slot has. An interface fails with "Index signature for type 'string'
 * is missing" and the 12-line job adapter in the README stops compiling
 * (measured; design 0.4-3).
 *
 * The outcome counters can sum to less than `claimed`: a claim lost mid-pass is
 * neither an outcome nor a failure, and it is logged rather than counted.
 */
type NotificationRelaySummary = {
    readonly ok: boolean;
    readonly claimed: number;
    readonly relayed: number;
    readonly suppressed: number;
    readonly alreadyRelayed: number;
    readonly noLongerLive: number;
    readonly failed: 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

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