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


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

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

### Fonctions (3)

#### `binaryPayloadLabel`

```ts
function binaryPayloadLabel(byteLength: number): string
```

Étiquette d'une charge binaire dans un journal — `[binary N B]`, jamais un vidage.

#### `isRealtimePayload`

```ts
function isRealtimePayload(value: unknown): value is object
```

Dit si une valeur est une charge realtime admise : absente, un objet, un tableau ou des octets — jamais un nombre, une chaîne, un booléen ni `null`.

#### `realtimePayloadError`

```ts
function realtimePayloadError(channel: string, value: unknown): TypeError
```

Construit l'erreur levée quand un producteur publie une charge refusée par `isRealtimePayload`.

---

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