Référence d'API — nodefony/client — realtime-presenceView
stable
Documentation › Référence d’API › nodefony › client-realtime-presenceView
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" — 7 symboles.
Classes (1)#
PresenceView#
class PresenceView
Vue d’un canal tenue à partir des trames realtime:presence — la règle pure applied / gap / stale (RFC 5263 §4.5) appliquée à une Map (aucune clé héritée, __proto__ sans effet).
readonly channel: string— Nom EXACT du canal suivi — une trame d’un autre canal est refusée.constructor(channel: string)get synced(): boolean—truequand la vue a une référence de version (une trame complète, sans trou depuis).get reference(): number | null— Version de la dernière trame appliquée, ounullsi la vue n’est pas synchronisée.apply(frame: RealtimePresenceFrame): NumberedChangeOutcome— Applique une trame reconnue parisPresenceFrame.unsync(): boolean— Retire la référence de version : la vue reste affichée, marquéepartial, et tout changement y rendgapjusqu’à la prochaine trame complète.snapshot(): IPresenceSnapshot— Instantané immuable de la vue — le même objet tant qu’elle ne change pas.
Fonctions (1)#
isPresenceFrame#
function isPresenceFrame(value: unknown): value is RealtimePresenceFrame
Lecteur à liste fermée d’une trame realtime:presence reçue : true si elle est recevable, et alors typée telle quelle — aucune copie, aucune allocation.
Constantes (3)#
EMPTY_PRESENCE#
const EMPTY_PRESENCE: IPresenceSnapshot
Instantané d’un canal dont aucune trame n’est arrivée — partagé, jamais modifié.
PRESENCE_RESYNC_JITTER#
const PRESENCE_RESYNC_JITTER = 0.25
Gigue ajoutée au délai de resynchronisation, en fraction de PRESENCE_RESYNC_MS (0 à 25 %, comme le premier battement de la preuve de vie) : des onglets qui voient le même trou ne redemandent pas la liste au même instant.
PRESENCE_RESYNC_MS#
const PRESENCE_RESYNC_MS = 2000
Délai minimal entre deux re-subscribe d’un même canal émis pour combler un trou de version (ADR-0025 P2 bis, S-rt-103) — la protection du serveur, qui renvoie TOUJOURS la liste, est cette limite côté client.
Interfaces (2)#
IPresenceSnapshot#
interface IPresenceSnapshot extends IPresenceView
Instantané de la vue d’un canal côté navigateur — IPresenceView plus ready.
readonly ready: boolean—falsetant qu’aucune trame complète n’est arrivée : « vide » et « pas encore reçu » ne se confondent pas (l’état neutre de RFC 6665 §4.1.2.4).
IPresenceView#
interface IPresenceView
Ce qu’un lecteur voit de la présence d’un canal — la même forme côté serveur (hub.presence()) et côté navigateur (socket, liaisons).
readonly count: number— Identités NOMMÉES distinctes présentes (comptes seulement).readonly unnamed: number— Connexions comptées sans être nommées (anonymes, appelants machine sans compte).readonly members: ReadonlyMap<string, IPresenceEntry>— Les présents nommés : identité →{ tabs, states? }.readonly partial: boolean—truesi la vue est connue incomplète ou figée : le serveur le dit (liste locale avant la réponse des pairs, bus perdu), ou la vue du navigateur n’est plus synchronisée (socket fermée, trou de versio …