---
title: "Référence d'API — @nodefony/realtime — decorators"
source: docs/api/realtime/decorators.md
url: https://nodefony.github.io/nodefony-core/docs/api/realtime/decorators/
---


[Documentation](../../../) › [Référence d'API](../../) › [`@nodefony/realtime`](../) › decorators

> Générée depuis les déclarations de types publiées de `@nodefony/realtime` **10.0.0-beta.5** : exactement ce que reçoit une application qui l'installe. Cette page n'existe dans aucun dépôt — pour la corriger, on corrige le TSDoc du code.

## `@nodefony/realtime`

`import { … } from "@nodefony/realtime"` — 6 symboles.

### Fonctions (5)

#### `RealtimeAction`

```ts
function RealtimeAction(method: string, policy?: IChannelPolicy): MethodDecorator
```

Décorateur **méthode** — expose une **action RPC** request→response du controller realtime sous le nom `method` (ex. `"nodefony:kernel:ping"`, `"chat:send"`).

#### `RealtimeBroadcast`

```ts
function RealtimeBroadcast(...prefixes: string[]): ClassDecorator
```

Décorateur **classe** — déclare les préfixes de canaux **broadcast** (cross-process) servis par cet endpoint : leurs publications traversent le `IBackplane` au lieu de rester dans le processus.

#### `RealtimeChannel`

```ts
function RealtimeChannel(channel: string, policy?: IChannelPolicy): MethodDecorator
```

Décorateur **méthode** — expose un **canal pub/sub** sous le nom `channel` (match EXACT, sans préfixe `:<ms>` ni regex). La méthode décorée DOIT renvoyer un `dispose: () => void` (la base le mémorise et l'appelle au dernier désabonné, comme avec l'override classique).

#### `RealtimeInbound`

```ts
function RealtimeInbound(method: string, policy?: IChannelPolicy): MethodDecorator
```

Décorateur **méthode** — déclare un **canal FULL-DUPLEX entrant** (méthode WS inverse : le client pousse via une notification `method: <name>`, params libres, sans `id`). La méthode décorée reçoit `(params, reply)` : - `params` : NON FIABLE (entrée client) — valider AVANT d'agir. - `reply(payload)` : push serveur→client sur le MÊME canal, vers CETTE connexion.

#### `getDeclaredBroadcastPrefixes`

```ts
function getDeclaredBroadcastPrefixes(): string[]
```

Préfixes broadcast déclarés par décorateur (introspection / tests).

### Types (1)

#### `RealtimeChannelFactory`

```ts
type RealtimeChannelFactory = (channel: string, publish: RealtimePublish) => () => void
```

Factory d'un provider de canal — appelée par la base au 1ᵉʳ `subscribe`.

---

[← Toutes les références d'API](../../)