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


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

> 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/client`

`import { … } from "nodefony/client"` — 15 symboles.

### Fonctions (7)

#### `getCurrentRequestId`

```ts
function getCurrentRequestId(): string
```

`requestId` de la portée courante, `undefined` en dehors de `withRequestId`.

#### `getPageId`

```ts
function getPageId(): string
```

Identifiant stable de ce chargement de page (UUID v4), généré à la demande.

#### `installErrorCapture`

```ts
function installErrorCapture(opts: ErrorCaptureOptions): () => void
```

Installe la capture des erreurs globales du navigateur.

#### `installRequestIdProvider`

```ts
function installRequestIdProvider(): () => void
```

Branche `getCurrentRequestId` sur `Pdu.requestIdProvider`, de sorte que tout `Pdu` créé dans une portée `withRequestId` porte son `requestId` — le même champ que côté serveur, donc la même clé de recoupement, sans qu'aucun appelant ait à le répéter.

#### `installSyslogUplink`

```ts
function installSyslogUplink(opts: SyslogUplinkOptions): () => void
```

Installe la remontée des journaux du navigateur vers le pod.

#### `resetClientLogContext`

```ts
function resetClientLogContext(): void
```

Remet le module à son état initial — réservé aux tests, qui doivent pouvoir repartir d'une page « neuve » sans recharger un document.

#### `withRequestId`

```ts
function withRequestId<T>(requestId: string, fn: () => T): T
```

Exécute `fn` en déclarant que ce qu'elle journalise appartient à la requête `requestId`.

### Constantes (3)

#### `BROWSER_ERROR_MSGID`

```ts
const BROWSER_ERROR_MSGID = "BROWSER_ERROR"
```

Catégorie par défaut d'une exception non rattrapée.

#### `BROWSER_REJECTION_MSGID`

```ts
const BROWSER_REJECTION_MSGID = "BROWSER_REJECTION"
```

Catégorie d'une promesse rejetée sans `catch`.

#### `UPLINK_MSGID`

```ts
const UPLINK_MSGID = "CLIENT_UPLINK"
```

Catégorie (`msgid`) réservée à ce que le transport dit de LUI-MÊME. Les entrées qui la portent sont **exclues** de la remontée : sans cette exclusion, un envoi qui échoue journalise son échec, ce qui produit une entrée, qui déclenche un envoi, qui échoue.

### Interfaces (5)

#### `ErrorCaptureOptions`

```ts
interface ErrorCaptureOptions
```

- `syslog: Syslog` — Le journal client qui recevra les entrées.
- `msgid?: string` — Catégorie (`msgid`) des entrées produites.
- `dedupeMs?: number` — Fenêtre de déduplication des erreurs IDENTIQUES consécutives, en ms.

#### `SyslogUplinkOptions`

```ts
interface SyslogUplinkOptions
```

- `syslog: Syslog` — Le journal client à écouter.
- `publisher: UplinkPublisher` — La socket par laquelle pousser (typiquement le `NodefonySocket` partagé).
- `maxSeverity?: number` — Sévérité maximale retenue (RFC 5424 : plus le nombre est petit, plus c'est grave).
- `batchMs?: number` — Fenêtre de regroupement, en ms.
- `maxBatch?: number` — Entrées par lot au maximum ; au-delà, on envoie sans attendre.
- `maxQueue?: number` — Profondeur du tampon ; au-delà, la plus ANCIENNE est perdue.
- `maxStringLength?: number` — Longueur maximale d'une chaîne transportée (message, pile).
- `channel?: string` — Canal montant.

#### `UplinkBatch`

```ts
interface UplinkBatch
```

Enveloppe d'un lot poussé sur le canal montant.

- `pageId: string` — Identifiant de ce chargement de page — la clé de regroupement d'un onglet.
- `entries: WireLogEntry[]` — Les entrées, dans l'ordre d'émission.
- `dropped?: number` — Entrées perdues depuis le dernier lot (tampon plein).

#### `UplinkPublisher`

```ts
interface UplinkPublisher
```

Le strict nécessaire pour pousser — n'impose pas `NodefonySocket` à l'appelant.

- `publish(channel: string, payload?: unknown): void`

#### `WireLogEntry`

```ts
interface WireLogEntry
```

Une entrée de journal telle qu'elle voyage sur le fil (plate, sérialisable).

- `severity: number` — Sévérité RFC 5424 (0-7).
- `severityName: string` — Nom de la sévérité (`"ERROR"`, `"INFO"`…).
- `moduleName: string` — Module émetteur **tel que le client le prétend** — le pod ne le croit pas.
- `msgid: string`
- `msg: string`
- `timeStamp: number` — Horloge du NAVIGATEUR (ms epoch) — jamais celle du pod.
- `requestId?: string` — Requête connue au moment du journal, absente si elle ne l'était pas.
- `payload: unknown` — Charge normalisée : une `Error` devient `{name, message, stack}`.

---

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