Nodefony 10.0.0-beta.7
Framework Node.js fullstack — HTTP & WebSocket, même contexte

Référence d'API — @nodefony/http/grpc

stable

Documentation › Référence d’API › @nodefony/http › sous-chemin-grpc

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

import { … } from "@nodefony/http/grpc" — 8 symboles.

Classes (2)#

GrpcCall#

class GrpcCall implements ContextValues, IRpcCall

Fiche d’un appel gRPC : ce que Nodefony attache à l’appel, et le ContextValues que Connect remet au gestionnaire (ctx.values).

GrpcEndpoint#

class GrpcEndpoint<S extends DescService = DescService>

Point d’entrée gRPC d’un service : possède l’adaptateur Connect (connectNodeAdapter) et lui confie la requête et la réponse BRUTES de Node d’un contexte déjà passé par le pipeline (pare-feu, gardes).

Fonctions (2)#

hasAbort#

function hasAbort(ctx: HandlerContext): ctx is IAbortableHandlerContext

Garde de type : le contexte d’appel porte-t-il abort ? Connect le pose sur tout contexte qu’il crée ; le garde le CONSTATE au lieu de le supposer, pour qu’une version de Connect qui le retirerait se voie à l’exécution (et au test qui le garde) plutôt que par un appel qui ne s’interrompt plus.

markGrpcRoute#

function markGrpcRoute(route: { grpc?: boolean; }): void

Marque une route comme servie par un point d’entrée gRPC — au démarrage, par @nodefony/framework/grpc. Allume la garde qui refuse en 12 une requête gRPC native aboutie à une route qui n’est pas gRPC (ADR-0026 D13 point 3) : tant qu’aucune route n’est marquée, la garde coûte une lecture de booléen.

Interfaces (4)#

IAbortableHandlerContext#

interface IAbortableHandlerContext extends HandlerContext

Le contexte d’appel que Connect remet réellement au gestionnaire : son type public (HandlerContext) ne dit pas abort, que porte pourtant l’objet créé par createHandlerContext (HandlerContextController, non exporté).

IGrpcEndpointOptions#

interface IGrpcEndpointOptions

Options d’un GrpcEndpoint.

IGrpcProtocols#

interface IGrpcProtocols

Protocoles servis — la section grpc de la configuration http (ADR-0026 D3, point 5).

IGrpcSettings#

interface IGrpcSettings extends IGrpcProtocols

La section grpc de la configuration http : protocoles servis (D3, point 5) et bornes des messages (D4, points 1, 2 et 6).


← Toutes les références d’API