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


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

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

### Fonctions (2)

#### `containsBytes`

```ts
function containsBytes(value: unknown): boolean
```

Dit si une valeur contient un `Uint8Array`, à n'importe quelle profondeur.

#### `textCodecForMarker`

```ts
function textCodecForMarker(marker: unknown): IFrameCodec
```

Le codec JSON qui relit un texte selon le marqueur que son émetteur a annoncé — champ `bytes` de l'accueil sur la socket, en-tête `BYTES_MARKER_HEADER` sur le REST. Une seule règle pour les deux transports : la convention n'est relue que si elle est annoncée, sinon un objet applicatif `{"$bytes": …}` changerait de nature.

### Constantes (4)

#### `BYTES_MARKER`

```ts
const BYTES_MARKER = "$bytes"
```

Clé réservée du marqueur d'octets dans le codec JSON.

#### `BYTES_MARKER_HEADER`

```ts
const BYTES_MARKER_HEADER = "x-nodefony-bytes"
```

En-tête HTTP par lequel une réponse REST annonce la convention d'octets — le pendant du champ `bytes` de `realtime:welcome` sur la socket. Absent, le corps est du JSON natif : un objet `{"$bytes": …}` y reste un objet (ADR-0022 §2).

#### `JSON_BYTES_FRAME_CODEC`

```ts
const JSON_BYTES_FRAME_CODEC: { protocol: string; bytesMarker: string; encode(frame: unknown): string; decode(data: string | Uint8Array): unknown; }
```

Le codec JSON quand l'application a ACTIVÉ le binaire : la convention `$bytes` pour les octets, à toute profondeur, dans les deux sens.

#### `JSON_FRAME_CODEC`

```ts
const JSON_FRAME_CODEC: { protocol: string; encode(frame: unknown): string; decode(data: string | Uint8Array): unknown; }
```

Le codec JSON par défaut de la socket : `JSON.stringify` / `JSON.parse`, rien d'autre.

---

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