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


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

> Générée depuis les déclarations de types publiées de `@nodefony/realtime` **10.0.0-beta.5** : 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/realtime`

`import { … } from "@nodefony/realtime"` — 4 symboles.

### Fonctions (2)

#### `defineRealtimeConfig`

```ts
function defineRealtimeConfig(config?: IRealtimeConfigInput, options?: { backplane?: IBackplane; }): IRealtimeConfig
```

Builder type-safe de la configuration de `@nodefony/realtime`.

#### `realtimeConfigJsonSchema`

```ts
function realtimeConfigJsonSchema(): unknown
```

JSON Schema introspectable de la config realtime — destiné au formulaire d'édition Studio (futur). N'inclut PAS `backplane.instance` (non sérialisable).

### Types (2)

#### `IRealtimeConfig`

```ts
type IRealtimeConfig = IRealtimeSchemaConfig & { backplane: IRealtimeSchemaConfig["backplane"] & { instance?: IBackplane; }; }
```

Config normalisée et gelée (sortie du builder, lue par `RealtimeService`).

#### `IRealtimeConfigInput`

```ts
type IRealtimeConfigInput = z.input<typeof realtimeConfigSchema>
```

Entrée du builder (champs avec défaut optionnels).

---

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