Référence d'API — nodefony/client — realtime-platformChannels
stable
Documentation › Référence d’API › nodefony › client-realtime-platformChannels
Générée depuis les déclarations de types publiées de
nodefony10.0.0-beta.7 : 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/client#
import { … } from "nodefony/client" — 9 symboles.
Fonctions (1)#
isPlatformChannel#
function isPlatformChannel(name: string): boolean
Le nom désigne-t-il une surface de la plateforme (canal OU méthode) ?
Constantes (5)#
NODEFONY_CHANNEL_NAMESPACE#
const NODEFONY_CHANNEL_NAMESPACE = "nodefony:"
Marque des surfaces de plateforme sur la socket. Un canal qui commence par ce préfixe décrit le serveur, jamais le métier de l’application.
PLATFORM_CHANNELS#
const PLATFORM_CHANNELS: { readonly syslog: "nodefony:syslog"; readonly audit: "nodefony:audit"; readonly dashboard: "nodefony:dashboard"; readonly supervision: "nodefony:supervision"; readonly debugbar: "nodefony:debugbar"; readonly socket: "nodefony:socket"; readonly ormHealth: "nodefony:orm:health"; readonly ormFlow: "nodefony:orm:flow"; readonly ormRich: "nodefony:orm:rich"; readonly scaffoldJ …
Canaux de diffusion de la plateforme (le serveur pousse, les écrans regardent).
PLATFORM_EVENTS#
const PLATFORM_EVENTS: { readonly hmr: "nodefony:hmr"; readonly debugbarSelect: "nodefony:debugbar:select"; }
Événements DOM de la plateforme (window), dans le même espace de nommage.
PLATFORM_INBOUND#
const PLATFORM_INBOUND: { readonly syslogUplink: "nodefony:syslog:uplink"; }
Canaux MONTANTS de la plateforme (le navigateur pousse, le pod reçoit).
PLATFORM_METHODS#
const PLATFORM_METHODS: { readonly ping: "nodefony:kernel:ping"; readonly gc: "nodefony:kernel:gc"; readonly scaffoldPreview: "nodefony:scaffold:preview"; readonly scaffoldRun: "nodefony:scaffold:run"; readonly scaffoldCancel: "nodefony:scaffold:cancel"; readonly throughput: "nodefony:realtime:throughput"; }
Méthodes RPC de la plateforme (le client demande, le serveur répond).
Types (3)#
PlatformChannel#
type PlatformChannel = (typeof PLATFORM_CHANNELS)[keyof typeof PLATFORM_CHANNELS]
Nom d’un canal de plateforme (valeur de PLATFORM_CHANNELS).
PlatformInboundChannel#
type PlatformInboundChannel = (typeof PLATFORM_INBOUND)[keyof typeof PLATFORM_INBOUND]
Nom d’un canal montant de plateforme (valeur de PLATFORM_INBOUND).
PlatformMethod#
type PlatformMethod = (typeof PLATFORM_METHODS)[keyof typeof PLATFORM_METHODS]
Nom d’une méthode RPC de plateforme (valeur de PLATFORM_METHODS).