Skip to content

NestNotificationsModule — @gj-kit/nest-notifications

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

import { NestNotificationsModule } from '@gj-kit/nest-notifications';
/**
* The notification pipeline as a Nest module.
*
* Deliberately not `@Global()`: a host that wants these providers everywhere says
* so itself. Everything the pipeline needs is a required option, because a
* silently working default would mean the library chose someone's product policy
* — the store trio, the presenter, the policy and the application key have no
* defaults for exactly that reason.
*/
declare class NestNotificationsModule {
/**
* Synchronous wiring. Configuration is validated here, at assembly time: an
* empty `applicationKey` or `providers` list fails to boot rather than failing
* on the scheduler's first call.
*/
static forRoot(options: NestNotificationsOptions): DynamicModule;
/**
* Asynchronous wiring, for hosts whose stores or policy come from other
* providers. The same assembly-time validation runs immediately after the
* factory resolves, so the boot-failure guarantee survives this path.
*/
static forRootAsync(options: NestNotificationsAsyncOptions): DynamicModule;
}

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: .
  • Source: GitHub