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


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

> 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"` — 2 symboles.

### Constantes (1)

#### `JSON_PROTOCOL`

```ts
const JSON_PROTOCOL = "nodefony.jsonrpc.v1"
```

Sous-protocole WebSocket (RFC 6455 §1.9) du codec texte — le format d'une connexion qui n'en a négocié aucun (décision 1 de #630). Nom versionné : une enveloppe qui change ajoute `v2`, jamais ne renomme `v1`.

### Interfaces (1)

#### `IFrameCodec`

```ts
interface IFrameCodec
```

Codec de frame de la socket temps réel : remplace, par frame, le `JSON.stringify` à l'envoi et le `JSON.parse` à la réception — aucun appel de plus.

- `readonly protocol: string` — Nom du sous-protocole offert par le client et annoncé dans `realtime:welcome`.
- `encode(frame: unknown): string | Uint8Array<ArrayBuffer>` — Sérialise une frame JSON-RPC pour le fil.
- `decode(data: string | Uint8Array): unknown` — Relit une trame reçue.
- `readonly textCodec?: IFrameCodec` — Pour un codec BINAIRE : le codec texte qui l'accompagne quand une connexion reste en `nodefony.jsonrpc.v1` — le JSON à convention d'octets (ADR-0022 §2).
- `readonly bytesMarker?: string` — Pour un codec TEXTE : le marqueur de la convention d'octets qu'il émet et réanime (`$bytes`).

---

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