@zarex/client
v0.1.5
Published
Zarex — client HTTP du Decision Engine (fetch, délai, disjoncteur, fail-open)
Readme
@zarex/client
Client HTTP bas niveau du SDK Zarex, avec disjoncteur (circuit breaker) intégré pour échouer vite plutôt que de faire attendre vos visiteurs quand Zarex est lent ou injoignable.
Vous n'avez normalement pas besoin d'installer ce paquet directement. Il est utilisé par
@zarex/coreet, par transitivité, par tous les adaptateurs de framework (@zarex/express,@zarex/fastify,@zarex/next,@zarex/sveltekit,@zarex/bun). Installez-le directement seulement si vous construisez votre propre intégration, en dehors de@zarex/core.
Qu'est-ce que Zarex ?
Zarex est une plateforme de sécurité applicative : un service qui protège une application web contre les bots, les abus de trafic, les injections et les fuites de données sensibles.
Utilisation
import { createClient, parseDecision } from "@zarex/client";
const client = createClient({ key: process.env.ZAREX_KEY! });
const response = await client.decide(request);
const decision = parseDecision(response);ClientOptions
| Option | Type | Description |
|---|---|---|
| key | string | Clé API du projet. |
| timeoutMs | number | Délai maximal avant d'abandonner l'appel (défaut 500 ms). |
| breaker | BreakerOptions \| false | Configuration du disjoncteur, ou false pour le désactiver. |
| baseUrl | string | Inutile en usage normal. À ne définir que pour les tests ou un environnement local. |
Le disjoncteur (CircuitBreaker)
Après un nombre configurable d'échecs consécutifs, le disjoncteur s'ouvre : les appels suivants échouent immédiatement (sans round-trip réseau) pendant une période de pause, puis une requête de sonde est tentée pour voir si le service est de nouveau disponible. Ce comportement évite qu'un ralentissement ne se répercute sur chaque requête de votre application par un délai d'attente répété.
import { CircuitBreaker } from "@zarex/client";
const breaker = new CircuitBreaker({ failureThreshold: 5, cooldownMs: 10_000 });Erreurs
| Classe | Quand |
|---|---|
| ZarexConfigError | Configuration invalide (clé manquante, option hors bornes…) — levée à la construction, jamais pendant le traitement d'une requête. |
| ZarexClientError | Erreur réseau ou réponse inattendue lors d'un appel — voir error.code (ClientErrorCode). |
Dans tous les adaptateurs de haut niveau, ces erreurs sont systématiquement interceptées : elles ne remontent jamais jusqu'à votre application (fail-open — si Zarex est injoignable, lent ou répond de façon inattendue, la requête du visiteur passe toujours).
Licence
MIT
