アプリケーションでの JavaScript モジュールの作成と使用

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む4読むのに数分

    • JavaScript モジュールで再利用可能なコードブロックを定義して、コードベースを最適化します。

    始める前に

    必要なロール：admin

    このタスクについて

    JavaScript モジュールの作成に使用される構文に関する一般的な情報については、MDN Web Docs ウェブサイトの JavaScript モジュール ページを参照してください。アプリケーションで TypeScript を使用するには、「」を参照してください SDK での ServiceNow TypeScript の使用。

    手順

    1. で Visual Studio Code、スコープ対象のアプリケーション ディレクトリを開きます。
    2. src ディレクトリに、再利用するモジュールコードを格納する JavaScript ファイルまたは TypeScript ファイルを作成します。
    3. オプション: グローバル Glide API をインポートして、モジュールから呼び出します。 
      import { gs } from '@servicenow/glide'
    4. 再利用するコードをエクスポートします。
      1. モジュールで、エクスポートするコードを エクスポート ステートメントで指定します。

        名前付きエクスポートまたは既定のエクスポートを使用できます。名前付きエクスポートは変数、定数、関数、またはクラスにすることができますが、デフォルトのエクスポートは関数またはクラスのみにすることができます。

        次の例は、モジュール内の複数の機能 (関数と変数) の名前付きエクスポートを追加する 1 つの方法です。
        export { myFunction, myVariable };
      2. アプリケーションの package.json ファイルで、 exports フィールドでこのモジュールにアクセスするための外部モジュールと他のアプリケーションのスクリプトのエントリーポイントを宣言します。
        エクスポートフィールドには、すべてのサブパスキー (".") またはメインエントリ名キーのいずれかが含まれている必要があります。

        この例では、 main.js モジュールは数学アプリケーションのパッケージからエクスポートされます。

        {
	"name": "math",
	"version": "1.0.0",
	"exports": {
		".": "./src/main.js"
	}
}
    5. 外部スクリプトまたは異なるアプリケーションのモジュールでモジュールコードを使用するには、モジュールを他のアプリケーションの依存関係として宣言します。
      1. 他のアプリケーションの package.json ファイルを開きます。
      2. モジュールのアプリケーションを 依存関係 フィールドとの依存関係として追加します。

        この例では、「math」アプリケーションのモジュールを使用するために、「test」アプリケーションはそのモジュールへの依存関係を宣言します。

        {
	"name": "test",
	"version": "1.0.0",
	"dependencies": {
		"math": "1.0.0"
	}
}
    6. エクスポートされたモジュールのコードをサーバー側スクリプトまたは他のモジュールで使用します。
      ファイルステップ
      モジュール
      1. src ディレクトリから、JavaScript モジュールを作成するか開きます。
      2. import ステートメントを使用してモジュールコードをインポートします。
        次の例は、エクスポートされた機能をモジュールにインポートする 1 つの方法です。
        import { feature } from "path/to/module";
      3. このモジュールからモジュール コードを呼び出し、再利用します。
      サーバーサイドスクリプト
      1. インスタンスで、ビジネスルールなどのスクリプトレコードを開きます。
      2. require ステートメントを使用してモジュールコードをインポートします。
        次の例は、エクスポートされた機能をスクリプトにインポートする 1 つの方法です。
        const { feature } = require("path/to/module");
      3. このスクリプトからモジュールコードを呼び出し、再利用します。

    次のタスク

    JavaScript モジュールでサードパーティライブラリを使用するか、変更をビルドしてインスタンスに展開します。詳細については、アプリケーションでのサードパーティライブラリの使用およびSDK を使用した ServiceNow アプリケーションのビルドとデプロイを参照してください。