Référence d'API — @nodefony/framework — config

stable

Documentation › Référence d’API › @nodefony/framework › config

Générée depuis les déclarations de types publiées de @nodefony/framework 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/framework#

import { … } from "@nodefony/framework" — 5 symboles.

Fonctions (2)#

defineFrameworkConfig#

function defineFrameworkConfig(config?: IFrameworkConfigInput): IFrameworkConfig

Builder type-safe de la configuration de @nodefony/framework (PUR — ne retape JAMAIS un défaut : source unique = ./config.ts).

frameworkConfigJsonSchema#

function frameworkConfigJsonSchema(): unknown

JSON Schema introspectable de la config framework — destiné au formulaire d’édition Studio et à la documentation générée (les flags de champ posés via .meta() sont recopiés par z.toJSONSchema).

Constantes (1)#

frameworkConfigSchema#

const frameworkConfigSchema: z.ZodObject<{ router: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>; adminBroker: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>; idempotency: z.ZodDefault<z.ZodObject<{ store: z.ZodDefault<z.ZodString>; gcIntervalS: z.ZodDefault<z.ZodNumber>; gcJitter: z.ZodDefault<z.ZodBoolean>; }, z.core.$strict>>; }, z.core.$strict>

Types (2)#

IFrameworkConfig#

type IFrameworkConfig = z.infer<typeof frameworkConfigSchema>

Type de sortie (config normalisée + défauts appliqués).

IFrameworkConfigInput#

type IFrameworkConfigInput = z.input<typeof frameworkConfigSchema>

Type d’entrée (toutes sections omissibles — défauts du schéma).

← Toutes les références d’API