Référence d'API — @nodefony/realtime — decorators

stable

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.6 : 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" — 7 symboles.

Fonctions (6)#

RealtimeAction#

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#

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#

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#

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.

RealtimePolicy#

function RealtimePolicy<P extends { readonly [name: string]: IChannelPolicy; }>(policies: P): <T extends abstract new (...args: never[]) => object>(target: T & PolicyNamesCheck<P, T>) => void

Décorateur de classe — pose les politiques d’accès d’actions ou de canaux par leur NOM, sans déclarer de handler.

getDeclaredBroadcastPrefixes#

function getDeclaredBroadcastPrefixes(): string[]

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

Types (1)#

RealtimeChannelFactory#

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