Créer et utiliser des modules JavaScript dans des applications

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 3 minutes de lecture

    • Optimisez votre base de code en définissant des blocs de code réutilisables avec des modules JavaScript.

    Avant de commencer

    Rôle requis : admin

    Pourquoi et quand exécuter cette tâche

    Pour des informations générales sur la syntaxe utilisée pour créer des modules JavaScript, consultez la page des modules JavaScript sur le site Web de MDN Web Docs. Pour utiliser TypeScript dans votre application, reportez-vous à la section Utilisation de TypeScript avec le Kit de développement logiciel (SDK)ServiceNow.

    Procédure

    1. Dans Visual Studio Code, ouvrez votre répertoire d’application incluse dans le périmètre.
    2. Dans le répertoire src , créez un fichier JavaScript ou TypeScript pour contenir le code du module que vous souhaitez réutiliser.
    3. Facultatif : Importez les API Glide globales pour les appeler à partir de votre module. 
      import { gs } from '@servicenow/glide'
    4. Exportez le code pour le réutiliser.
      1. Dans le module, identifiez le code à exporter avec des instructions d’exportation .

        Vous pouvez utiliser une exportation nommée ou une exportation par défaut. Les exportations nommées peuvent être des variables, des constantes, des fonctions ou des classes, tandis que les exportations par défaut ne peuvent concerner que des fonctions ou des classes.

        L’exemple suivant est une façon d’ajouter une exportation nommée pour plusieurs entités (une fonction et une variable) dans un module :
        export { myFunction, myVariable };
      2. Dans le fichier package.json de votre application, déclarez un point d’entrée pour que les modules externes et les scripts d’autres applications accèdent à ce module avec le champ d’exportations .
        Le champ d’exportation doit contenir toutes les clés de sous-chemin (« . ») ou les clés de nom d’entrée principale.

        Dans cet exemple, le module main.js est exporté à partir du package de l’application mathématique.

        {
	"name": "math",
	"version": "1.0.0",
	"exports": {
		".": "./src/main.js"
	}
}
    5. Pour utiliser le code du module dans des scripts externes ou des modules de différentes applications, déclarez le module en tant que dépendance de l’autre application.
      1. Ouvrez le fichier package.json de l’autre application.
      2. Ajoutez l’application du module en tant que dépendance avec le champ des dépendances .

        Dans cet exemple, pour utiliser des modules de l’application « math », l’application « test » déclare une dépendance à ceux-ci.

        {
	"name": "test",
	"version": "1.0.0",
	"dependencies": {
		"math": "1.0.0"
	}
}
    6. Utilisez le code du module exporté dans des scripts côté serveur ou d’autres modules.
      FichierÉtapes
      Module
      1. Dans le répertoire src , créez ou ouvrez un module JavaScript.
      2. Importez le code du module avec des instructions d’importation .
        L’exemple suivant est une façon d’importer une fonctionnalité exportée dans un module :
        import { feature } from "path/to/module";
      3. Appelez le code de module à partir de ce module pour le réutiliser.
      Script côté serveur
      1. Sur votre instance, ouvrez un enregistrement de script, tel qu’une règle métier.
      2. Importez le code du module avec les instructions require .
        L’exemple suivant est une façon d’importer une fonctionnalité exportée dans un script :
        const { feature } = require("path/to/module");
      3. Appelez le code de module à partir de ce script pour le réutiliser.

    Que faire ensuite

    Utilisez des bibliothèques tierces dans un module JavaScript ou générez et déployez vos modifications dans une instance. Pour plus d'informations, voir Utiliser des bibliothèques tierces dans les applications ou Créer et déployer une application avec le Kit de développement logiciel (SDK ServiceNow ).