Modules JavaScript et bibliothèques tierces

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 3 minutes de lecture

    • Optimisez votre base de code à l’aide de modules JavaScript pour regrouper le code connexe ou ajouter des bibliothèques tierces et réutiliser leur code dans les applications.

    Vue d’ensemble de l’utilisation des modules JavaScript

    Un module est un fichier JavaScript qui contient du code connexe qui est partagé et réutilisé au sein des applications sur une instance. Vous pouvez ajouter des modules JavaScript et des bibliothèques tierces dans les applications incluses dans le périmètre qui sont créées ou converties avec le ServiceNow IDE ou ServiceNow SDK. Vous pouvez également utiliser TypeScript pour créer des modules et les compiler en JavaScript avant de créer votre application. Sur une instance, les modules JavaScript sont stockés dans la table du module EcmaScript [sys_module].

    Dans un module, vous identifiez le code à réutiliser avec des instructions d’exportation . Ensuite, utilisez des instructions import ou require pour réutiliser le code ailleurs dans vos applications. Les applications doivent déclarer leurs dépendances à des bibliothèques npm (Node Package Manager) tierces pour utiliser leur code de module. Pour des informations générales sur la syntaxe utilisée pour créer des modules JavaScript, consultez la page Modules JavaScript sur le site Web MDN Web Docs.

    Remarque :
    Pour utiliser les API Glide globales dans les modules, elles doivent être importées à partir du package @servicenow/glide . Par exemple : import { gs } from '@servicenow/glide'.

    Limitations

    • Les applications globales et personnalisations d’application ne sont pas prises en charge.
    • Les modules ne peuvent être utilisés que dans le périmètre de l’application dans lequel ils sont ajoutés. Ils ne peuvent pas être utilisés dans tous les périmètres de l’application.
    • Un sous-ensemble de fonctionnalités ECMAScript est pris en charge dans les modules conformément à la Prise en charge de la fonctionnalité du moteur JavaScript.
    • Node.js API ne sont pas prises en charge dans les modules.
    • Les variables globales liées aux API Web ne sont pas prises en charge.
    • Les bibliothèques tierces ajoutées à votre application ne peuvent pas accéder aux API ni les appeler ServiceNow .
    • Les modules CommonJS des bibliothèques tierces ne sont pas pris en charge à moins qu’ils ne définissent les exportations. Les importations de sous-chemins ne sont pas prises en charge avec les modules CommonJS. Les modules ECMAScript des bibliothèques tierces sont pris en charge.
    • Les instructions d’importation et d’exportation ne sont prises en charge que dans les modules. Pour importer du code de module dans des scripts, tels que des règles métier ou des includes de script, utilisez des instructions require .
    • Les modules JavaScript [sys_module] ne peuvent être modifiés que dans le ou avec Visual Studio Code le ServiceNow SDKServiceNow IDE .
    Important :
    Vous ne pouvez pas utiliser de bibliothèques tierces qui reposent sur des fonctionnalités non prises en charge, telles que des API ou des fonctionnalités ECMAScript non prises en charge.

    Exportation de modules

    Dans un module, identifiez le code à réutiliser avec des instructions d’exportation . Vous pouvez utiliser des exportations nommées ou des exportations par défaut. Les exportations nommées peuvent concerner des variables, des constantes, des fonctions ou des classes, tandis que les exportations par défaut peuvent concerner uniquement des fonctions ou des classes. L’exemple suivant est une façon d’ajouter une exportation nommée pour plusieurs fonctionnalités (une fonction et une variable) dans un module :
    export { myFunction, myVariable };

    Importation de modules

    Pour importer le code de module que vous souhaitez réutiliser, utilisez des instructions import dans d’autres modules ou exigez des instructions dans des scripts côté serveur.

    L’exemple suivant est une façon d’importer une fonction exportée dans un module :
    import { feature } from "path/to/module";
    L’exemple suivant est une façon d’importer une fonction exportée dans un script :
    const { feature } = require("path/to/module");
    Pour utiliser un raccourci pour importer du code de module, vous pouvez utiliser des sous-chemins d’accès dans le champ d’importation du fichier package.json de l’application. Par exemple :
    {
	"name": "math",
	"version": "1.0.0",
	"exports": {
		"./functions/*.js": "./src/functions/*.js",
		"./functions/private-functions/*": null
	},
	"imports": {
		"#calc": "calculus",
		"#derivative": "calculus/derivative"
	},
	"dependencies": {
		"calculus": "1.0.0"
	}
}
    Sur la base de cet exemple, au lieu d’écrire le chemin d’accès relatif à derivative.js chaque fois que vous souhaitez l’importer dans l’application mathématique , vous pouvez utiliser le raccourci #derivative à la place. Les sous-chemins d’accès peuvent également être utilisés dans le champ d’importation pour utiliser un raccourci pour les dépendances, telles que #calc.
    import { derivative } from '#derivative';
import * as calculus from '#calc';

    Ajout de dépendances

    Les applications doivent déclarer des dépendances à des bibliothèques tierces pour utiliser leur code de module. Dans le fichier de package.json d’une application, incluez le nom et la version du package pour toutes les dépendances. Par exemple, pour utiliser des modules de la bibliothèque « math » dans l’application « test », ajoutez le package « math » en tant que dépendance :
    {
	"name": "test",
	"version": "1.0.0",
	"dependencies": {
		"math": "1.0.0"
	}
}