Référence d'API — nodefony — kernel-inspect

stable

Documentation › Référence d’API › nodefony › kernel-inspect

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

import { … } from "nodefony" — 12 symboles.

Fonctions (5)#

callAdminEndpoint#

function callAdminEndpoint(broker: IAdminBrokerLike, call: IAdminCall, caller: IAdminCaller): Promise<InspectResult>

Appelle un endpoint du plan d’administration, hors HTTP.

extractMarkdownSection#

function extractMarkdownSection(markdown: string, wanted: string): { title: string; markdown: string; } | null

Extrait UNE section d’un markdown, sous-sections comprises.

outlineMarkdown#

function outlineMarkdown(markdown: string): IMarkdownSection[]

Repère les titres d’un markdown, en ignorant les blocs de code.

readAdminSubject#

function readAdminSubject(broker: IAdminBrokerLike, subject: string, caller: IAdminCaller, target?: string): Promise<InspectResult>

Lit un sujet d’inspection dans le plan d’administration.

unwrapAdminResult#

function unwrapAdminResult(result: unknown): { status: number; data: unknown; }

Extrait la donnée d’une réponse d’administration.

Constantes (1)#

INSPECT_SUBJECTS#

const INSPECT_SUBJECTS: Record<string, IInspectSubject>

Sujets inspectables, et l’endpoint d’administration qui les sert.

Interfaces (4)#

IAdminBrokerLike#

interface IAdminBrokerLike

Vue minimale du broker dont cette lecture a besoin.

• list(): readonly IAdminApi[]

IAdminCall#

interface IAdminCall

Ce qu’il faut pour joindre un endpoint du plan d’administration.

• namespace: string — Producteur d’administration (kernel, framework, orm…).
• path: string — Chemin de l’endpoint, tel que le producteur le déclare.
• method?: AdminHttpMethod — Méthode de l’endpoint visé, défaut "GET".
• params?: Readonly<Record<string, string>> — Variables de route, quand le chemin en porte (module/{name}).
• query?: Readonly<Record<string, string | string[]>> — Paramètres de requête, tels qu’une URL les porterait.
• label?: string — Ce qu’on nomme dans les messages d’échec — le sujet, la cible, l’appel.

IInspectSubject#

interface IInspectSubject

Ce qu’un sujet inspectable désigne : où le lire dans le plan d’administration.

• namespace: string — Producteur d’administration (kernel, framework, orm…).
• path: string — Chemin de l’endpoint, tel que le producteur le déclare.
• summary: string — Ce que le sujet montre, en une ligne.
• param?: string — Nom du paramètre attendu, quand le chemin en porte un (module/{name}).
• filter?: string — Nom du filtre OPTIONNEL, passé en query plutôt qu’en segment de chemin.
• render?: "cards" — Rendu HUMAIN attendu — cards quand une colonne porte une PHRASE.

IMarkdownSection#

interface IMarkdownSection

Un titre du document, et ce qu’il ouvre.

• level: number — Niveau du titre : 1 pour #, 2 pour ##…
• title: string — Texte du titre, tel qu’il est écrit.
• line: number — Ligne (1-indexée) du titre dans le document.
• chars: number — Poids de la section, titre compris — de quoi choisir sans l’ouvrir.

Types (2)#

InspectFailure#

type InspectFailure = "unknown-subject" | "missing-target" | "target-not-supported" | "producer-missing" | "endpoint-missing" | "handler-failed" | "not-found" | "forbidden"

Pourquoi une lecture de sujet n’a pas abouti — chaque porte le traduit.

InspectResult#

type InspectResult = { ok: true; status: number; data: unknown; } | { ok: false; reason: InspectFailure; message: string; status?: number; body?: unknown; cause?: string; }

Résultat d’une lecture de sujet : la donnée, ou la raison de l’échec.

← Toutes les références d’API