Référence d'API — nodefony — realtime-userChannel

stable

Documentation › Référence d’API › nodefony › realtime-userChannel

Générée depuis les déclarations de types publiées de nodefony 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#

import { … } from "nodefony" — 4 symboles.

Fonctions (2)#

isOwnUserChannel#

function isOwnUserChannel(channel: string, who: ISubscriberIdentity): boolean

Règle d’admission du canal personnel : who n’entre que sur SON canal, par égalité de chaîne avec user:<son id>.

userChannel#

function userChannel(userId: string): string

Nom du canal personnel d’une identité : user:<id>.

Constantes (1)#

USER_CHANNEL_PREFIX#

const USER_CHANNEL_PREFIX = "user:"

Préfixe du canal PERSONNEL d’une identité — user:<id>, la brique « livrer à une personne » (ADR-0022 §6, D1).

Types (1)#

UserChannelPayload#

type UserChannelPayload<M extends EventsMap> = `user:${string}` extends keyof M ? M[`user:${string}`] : never

Charge du canal personnel déclarée par une carte d’événements — la valeur de sa clé gabarit [k: `user:${string}`]: …, never si la carte n’en déclare pas.

← Toutes les références d’API