---
title: "@playstack/nest-notifications"
description: "NestJS dependency injection and validated queue-consumer binding for portable notifications."
tags: ["package","communication","notifications","nestjs","queues","free"]
---

{/* package-access:start */}

> **Free.** MIT licensed. Check preview availability before installing. See [package access](/docs/packages#access-policy).

{/* package-access:end */}

`@playstack/nest-notifications` binds a configured `@playstack/notifications` facade to Nest dependency injection and a validated queue consumer. It does not install routes, select a queue driver, own request authentication, or register global providers.

{/* package-install:start */}

## Install

After confirming [preview access](/docs/packages#access-policy), install the package at your application's shared Playstack version:

```sh
npm install --save-exact @playstack/nest-notifications@0.1.0-beta.1
```

Check the peer requirements below before choosing a runtime or provider.

{/* package-install:end */}

## Configure

```ts
PlaystackNotificationsModule.forRoot(notifications)
```

For Nest-managed dependencies:

```ts
PlaystackNotificationsModule.forRootAsync({
  imports: [ApplicationNotificationsModule],
  inject: [APPLICATION_NOTIFICATIONS],
  useFactory: (notifications) => notifications,
})
```

## Connect the worker

```ts
await notificationConsumer.handle(job.data)
```

Bind the application queue job to `PlaystackNotificationConsumer.handle()`. The consumer parses the untrusted envelope with `parseNotificationJob()` before calling the core service's `process()` method.

Inject `NOTIFICATIONS_SERVICE` to access the original configured facade. Queueing, delivery, inbox persistence, preferences, locale resolution, and events remain core or application seams.

{/* package-reference:start */}

## API entry points and requirements

Reference snapshot: `@playstack/nest-notifications@0.1.0-beta.1`. Import only the entry point your runtime needs. Paths below are relative to the installed package; use **Go to Definition** in your editor to inspect exact parameters, return types and overloads. Do not import the declaration-file paths directly.

| Public entry point | Declaration file |
| --- | --- |
| `@playstack/nest-notifications` | `./dist/index.d.ts` |
| `@playstack/nest-notifications/package.json` | No TypeScript declaration (asset or metadata export). |

Node.js engine requirement: `>=20`. This is not a claim that every entry point works in browsers or Workers.

### Peer dependencies

Keep existing framework versions that satisfy these ranges. Install optional peers only when using the corresponding adapter. The package manager resolves ordinary dependencies separately.

| Peer | Compatible range | When needed |
| --- | --- | --- |
| `@nestjs/common` | `^10.0.0 \|\| ^11.0.0` | Required by the package. |
| `@playstack/notifications` | `0.1.0-beta.1` | Required by the package. |
| `reflect-metadata` | `^0.1.13 \|\| ^0.2.0` | Required by the package. |
| `rxjs` | `^7.0.0` | Required by the package. |

For a complete first program, start with [Getting started](/docs/getting-started). For API lookup and partial-example conventions, see [Reading the reference](/docs/packages#reading-the-reference). Provider failures, lifecycle requirements and application responsibilities remain described in the guide above; types alone do not establish production safety.

{/* package-reference:end */}