You asked, we delivered! Our Free Plan now includes a Custom Domain, 5 Actions, & 25K MAUs. Sign up! ads via Carbon

Read-Eval-Print-Loop (REPL)

REPL est un environnement interactif simple qui prend des entrées utilisateur uniques, les exécute et renvoie le résultat à l'utilisateur. La fonction REPL vous permet d'inspecter votre graphe de dépendance et d'appeler des méthodes sur vos fournisseurs (et contrôleurs) directement depuis votre terminal.

Usage#

Pour exécuter votre application NestJS en mode REPL, créez un nouveau fichier repl.ts (à côté du fichier main.ts existant) et ajoutez le code suivant à l'intérieur :

import { repl } from '@nestjs/core';
import { AppModule } from './src/app.module';

async function bootstrap() {
  await repl(AppModule);
}
bootstrap();

import { repl } from '@nestjs/core';
import { AppModule } from './src/app.module';

async function bootstrap() {
  await repl(AppModule);
}
bootstrap();

Maintenant, dans votre terminal, démarrez le REPL avec la commande suivante :

$ npm run start -- --entryFile repl

Astucerepl renvoie un objet serveur Node.js REPL.

Une fois qu'il est opérationnel, vous devriez voir le message suivant dans votre console :

LOG [NestFactory] Starting Nest application...
LOG [InstanceLoader] AppModule dependencies initialized
LOG REPL initialized

Et maintenant vous pouvez commencer à interagir avec votre graphe de dépendances. Par exemple, vous pouvez récupérer un AppService (nous utilisons le projet starter comme exemple ici) et appeler la méthode getHello() :

> get(AppService).getHello()
'Hello World!'

Vous pouvez exécuter n'importe quel code JavaScript depuis votre terminal, par exemple, assigner une instance de AppController à une variable locale, et utiliser await pour appeler une méthode asynchrone :

> appController = get(AppController)
AppController { appService: AppService {} }
> await appController.getHello()
'Hello World!'

Pour afficher toutes les méthodes publiques disponibles sur un fournisseur ou un contrôleur donné, utilisez la fonction methods(), comme suit :

> methods(AppController)

Methods:
 ◻ getHello

Pour afficher tous les modules enregistrés sous forme de liste avec leurs contrôleurs et fournisseurs, utilisez debug().

> debug()

AppModule:
 - controllers:
  ◻ AppController
 - providers:
  ◻ AppService

Démo rapide :

Vous trouverez plus d'informations sur les méthodes natives prédéfinies existantes dans la section ci-dessous.

Fonctions natives#

Le REPL NestJS intégré est livré avec quelques fonctions natives qui sont globalement disponibles lorsque vous démarrez le REPL. Vous pouvez appeler help() pour les énumérer.

Si vous ne vous souvenez pas de la signature (c'est-à-dire des paramètres attendus et du type de retour) d'une fonction, vous pouvez appeler <nom_de_la_fonction>.help. Par exemple :

> $.help
Retrieves an instance of either injectable or controller, otherwise, throws exception.
Interface: $(token: InjectionToken) => any

Astuce Ces interfaces de fonction sont écrites en syntaxe d'expression de type de fonction TypeScript.

Mode de surveillance#

Pendant le développement, il est utile d'exécuter REPL en mode veille pour refléter automatiquement toutes les modifications du code :

$ npm run start -- --watch --entryFile repl

Cela a un défaut, l'historique des commandes du REPL est supprimé après chaque rechargement, ce qui peut s'avérer fastidieux. Heureusement, il existe une solution très simple. Modifiez votre fonction bootstrap comme suit :

async function bootstrap() {
  const replServer = await repl(AppModule);
  replServer.setupHistory(".nestjs_repl_history", (err) => {
    if (err) {
      console.error(err);
    }
  });
}

Désormais, l'historique est préservé entre les exécutions/rechargements.