# HTTP クライアントでサポートされる JavaScript API

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com/ja-jp/help/clion/llms.txt).

## console.log

HTTP クライアントは、応答ハンドラーまたは事前要求ハンドラースクリプトの出力にテキスト値 (またはコンマで区切られた複数の値) を出力する  `console.log()`  メソッドをサポートしています。 同じ目的に [client.log](http-client-reference.html) を使用することもできます。 例：

```HTTP_REQUEST_FULL
GET example.org

> {%
    console.log(response.status)
%}

```

JavaScript オブジェクト (  `console.log(response.body)`  など) を渡すこともでき、そのオブジェクトは適切な構文ハイライトとともに JSON 形式で出力に表示されます。

## DOM メソッドとプロパティ

HTTP クライアントは、レスポンス本文の一部として受信した (または [DOMParser](#DOMParser) を使用して作成された) XML および HTML ドキュメントを解析および操作できる DOM ツリーメソッドとプロパティの一部をサポートしています。 サポートされているメソッドは次のとおりです。

[getElementsByTagName()](https://developer.mozilla.org/en-US/docs/Web/API/Document/getElementsByTagName)
: 指定されたタグ名を持つ要素のコレクションを返します。 例：
:
:
:
:
: ```HTTP_REQUEST_FULL
: GET https://examples.http-client.intellij.net/xml
:
: > {%
: const slide = response.body.getElementsByTagName("slide")[0]
: console.log(slide)
: %}
:
: ```

[getElementsByName()](https://developer.mozilla.org/en-US/docs/Web/API/Document/getElementsByName)
: 指定された  `name`  属性を持つノードのコレクションを返します。 例：

[getElementById()](https://developer.mozilla.org/en-US/docs/Web/API/Document/getElementById)
: `id`  によって Element オブジェクトを取得します。

[getElementsByClassName()](https://developer.mozilla.org/en-US/docs/Web/API/Document/getElementsByClassName)
: 指定されたクラス名を持つすべての子要素の配列のようなオブジェクトを返します。

[DOMParser](https://developer.mozilla.org/en-US/docs/Web/API/DOMParser)
: `parseFromString()`  メソッドを使用して、文字列から XML または HTML ソースコードを DOM ドキュメントに解析します。 例：
:
:
:
:
: ```HTTP_REQUEST_FULL
:
: GET example.org
:
: > {%
: const xmlStr = '<q id="a"><span class="test" id="b">hey!</span><span id="bar">world</span><foo class="test" id="x-foo"/><bar name="x-foo"/></q>';
: const doc = new DOMParser().parseFromString(xmlStr, "application/xml");
:
: console.log(doc.getElementById("a"))
: console.log(doc.getElementById("b"))
: console.log(doc.getElementsByClassName("test"))
: console.log(doc.getElementsByTagName("span"))
: console.log(doc.getElementsByName("x-foo"))
: %}
:
:
: ```

[createElement(tagName)](https://developer.mozilla.org/en-US/docs/Web/API/Document/createElement)
: `tagName`  で指定された HTML 要素を作成します。
:
:
:
:
: ```HTTP_REQUEST_FULL
:
: GET example.org
:
: > {%
: const xmlStr = '<q id="a"><span class="test" id="b">hey!</span><span id="bar">world</span><foo class="test" id="x-foo"/><bar name="x-foo"/></q>';
: const doc = new DOMParser().parseFromString(xmlStr, "application/xml");
: const bodyElement = doc.createElement("body");
: %}
:
:
: ```

メソッド名を入力し始めると、サポートされているメソッドの補完が表示されます。 マウスをその上に移動すると、簡単なドキュメントが表示されます。 サポートされているすべての DOM メソッドとプロパティを表示するには、以下のセクションを展開します。

### サポートされているメソッド

|   `Node`  メソッド。  |   `Document`  メソッド。  |
| --- | --- |
|      * `[cloneNode()](https://developer.mozilla.org/en-US/docs/Web/API/Node/cloneNode)`    * `[compareDocumentPosition()](https://developer.mozilla.org/en-US/docs/Web/API/Node/compareDocumentPosition)`    * `[contains()](https://developer.mozilla.org/en-US/docs/Web/API/Node/contains)`    * `[getRootNode()](https://developer.mozilla.org/en-US/docs/Web/API/Node/getRootNode)`    * `[hasChildNodes()](https://developer.mozilla.org/en-US/docs/Web/API/Node/hasChildNodes)`    * `[insertBefore()](https://developer.mozilla.org/en-US/docs/Web/API/Node/insertBefore)`    * `[isConnected()](https://developer.mozilla.org/en-US/docs/Web/API/Node/isConnected)`    * `[isDefaultNameSpace()](https://developer.mozilla.org/en-US/docs/Web/API/Node/isDefaultNamespace)`    * `[isEqualNode()](https://developer.mozilla.org/en-US/docs/Web/API/Node/isEqualNode)`    * `[isSameNode()](https://developer.mozilla.org/en-US/docs/Web/API/Node/isSameNode)`    * `[lookupNamespaceURI()](https://developer.mozilla.org/en-US/docs/Web/API/Node/lookupNamespaceURI)`    * `[lookupPrefix()](https://developer.mozilla.org/en-US/docs/Web/API/Node/lookupPrefix)`    * `[nextSibling()](https://developer.mozilla.org/en-US/docs/Web/API/Node/nextSibling)`    * `[normalize()](https://developer.mozilla.org/en-US/docs/Web/API/Node/normalize)`    * `[removeChild()](https://developer.mozilla.org/en-US/docs/Web/API/Node/removeChild)`    * `[replaceChild()](https://developer.mozilla.org/en-US/docs/Web/API/Node/replaceChild)`    |      * `[createElement(tagName)](https://developer.mozilla.org/en-US/docs/Web/API/Document/createElement)`    * `[getElementById()](https://developer.mozilla.org/en-US/docs/Web/API/Document/getElementById)`    * `[getElementsByClassName()](https://developer.mozilla.org/en-US/docs/Web/API/Document/getElementsByClassName)`    * `[getElementsByName()](https://developer.mozilla.org/en-US/docs/Web/API/Document/getElementsByName)`    * `[getElementsByTagName()](https://developer.mozilla.org/en-US/docs/Web/API/Document/getElementsByTagName)`    |

### サポートされているプロパティ

|   `Element`  プロパティ  |   `Node`  プロパティ  |
| --- | --- |
|      * `[className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className)`    * `[id](https://developer.mozilla.org/en-US/docs/Web/API/Element/id)`    * `[tagName](https://developer.mozilla.org/en-US/docs/Web/API/Element/tagName)`    |      * `[isConnected](https://developer.mozilla.org/en-US/docs/Web/API/Node/isConnected)`    * `[firstChild](https://developer.mozilla.org/en-US/docs/Web/API/Node/firstChild)`    * `[lastChild](https://developer.mozilla.org/en-US/docs/Web/API/Node/lastChild)`    * `[nextSibling](https://developer.mozilla.org/en-US/docs/Web/API/Node/nextSibling)`    * `[nodeName](https://developer.mozilla.org/en-US/docs/Web/API/Node/nodeName)`    * `[nodeType](https://developer.mozilla.org/en-US/docs/Web/API/Node/nodeType)`    * `[nodeValue](https://developer.mozilla.org/en-US/docs/Web/API/Node/nodeValue)`    * `[ownerDocument](https://developer.mozilla.org/en-US/docs/Web/API/Node/ownerDocument)`    * `[parentNode](https://developer.mozilla.org/en-US/docs/Web/API/Node/parentNode)`    * `[previousSibling](https://developer.mozilla.org/en-US/docs/Web/API/Node/previousSibling)`    * `[textContent](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)`    |

## URLSearchParams

`URLSearchParams`  は、URL のクエリ文字列部分の操作を容易にする JavaScript オブジェクトです。  `URLSearchParams`  は、次の形式のパラメーターを受け入れます。

* クエリ文字列: `URLSearchParams("key=value&key2=value2");`

* URL パラメーターを表すキーと値のペア: `URLSearchParams({ key1: "value1", key2: "value2" })`

* キーと値のペアの配列: `URLSearchParams([["key1", "value1"], ["key2", "value2"]])`

HTTP クライアントは、 [既知の URLSearchParams メソッドをすべて](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams#instance_methods)サポートします。 例：

```HTTP_REQUEST_FULL
< {%

      client.global.set('query', 'foo=1&bar=2')

      const params = new URLSearchParams(client.global.get('query'));
      const params2 = new URLSearchParams([["planet", "tatooine"], ["year", "2"]]);
      const params3 = new URLSearchParams({key1: "value1", key2: "value2"});

      console.log(params.has("bar")); // outputs true
      console.log(params.has("param")); // outputs false
      params.append("foo", 3);
      console.log(params.getAll("foo")); // outputs ["1","3"]

      for (let value of params.values()) {
          console.log(value);  // outputs 1 2 3
      }

      for (let key of params2.keys()) {
          console.log(key);  // outputs planet year
      }

      client.global.set("query",params.toString())
   %}

  GET example.org/{{query}}

```

## Base64 エンコーディング: btoa と atob

HTTP クライアントは、 [btoa()](https://developer.mozilla.org/en-US/docs/Web/API/Window/btoa) および [atob()](https://developer.mozilla.org/en-US/docs/Web/API/Window/atob) メソッドをサポートしています。

* `Window.btoa(stringToEncode)` または `btoa(stringToEncode)` を使用して、 `stringToEncode` 文字列から Base64 でエンコードされた ASCII 文字列を作成します。

* Base64 エンコードを使用してエンコードされたデータの文字列をデコードするには、 `Window.atob(encodedData)` または `atob(encodedData)` を使用します。

例：

```HTTP_REQUEST_FULL
GET https://examples.http-client.intellij.net/ip

> {%
    const encodedData = Window.btoa("Hello, world"); // encode a string
    const decodedData = Window.atob(encodedData); // decode the string
    console.log(decodedData); // prints "Hello, world"
%}

```

## シェルコマンドを実行する

シェルコマンドを実行してオペレーティングシステムと対話できるように、HTTP Client は次のメソッドをサポートしています：

[exec(コマンド\[, オプション\]\[, callback\])](https://nodejs.org/api/child_process.html#child_processexeccommand-options-callback)
: シェルを生成し、そのシェル内でコマンドを実行し、生成された出力をバッファリングします。

[execFile(ファイル\[, args\]\[, オプション\]\[, callback\])](https://nodejs.org/api/child_process.html#child_processexecfilefile-args-options-callback)
: デフォルトではシェルを生成しないことを除けば、  `exec()`  と似ています。

[execSync(コマンド\[, オプション\])](https://nodejs.org/api/child_process.html#child_processexecsynccommand-options)
: 子プロセスが完全に閉じられるまでメソッドが返されない点を除いて、  `exec()`  と同じです。

[execFileSync(ファイル\[, args\]\[, オプション\])](https://nodejs.org/api/child_process.html#child_processexecfilesyncfile-args-options)
: 子プロセスが完全に閉じられるまでメソッドが返されない点を除いて、  `execFile()`  と同じです。

[spawn(コマンド\[, args\]\[, オプション\])](https://nodejs.org/api/child_process.html#child_processspawncommand-args-options)
: シェルを生成し、そのシェル内でコマンドを実行し、生成された出力をバッファリングします。

[spawnSync(コマンド\[, args\]\[, オプション\])](https://nodejs.org/api/child_process.html#child_processspawnsynccommand-args-options)
: 子プロセスが完全に閉じられるまで関数が返されない点を除いて、  `spawn()`  と同じです。

サポートされているオプションは次のとおりです。

cwd
: コマンドを実行するディレクトリを指定します。

env
: プロセスで利用可能な環境変数のセットを指定します。

timeout
: プロセスが実行を許可される最大時間（ミリ秒単位）を指定します。

maxBuffer
: 出力のサイズに対して最大制限（文字数）を設定します。

shell
: コマンドを実行するシェルを指定します。

シグナル
: プロセスを終了する際に送信するシグナルを指定します

コールバック
: オプションではなく、非同期メソッドに渡すことができる別のパラメーターです。 コールバックはプロセスが終了したときに呼び出される関数です。

例：

```HTTP_REQUEST_FULL

### List all directories in the specified folder

GET https://examples.http-client.intellij.net

> {%
  const result = execSync("ls -l", {
      cwd: '/Users/John.Doe/Docs/'
  })
  console.log(`result: ${result}`)
%}


### Pass an environment variable to the process

< {%
  const result = execSync('bash -c "set"', {
    env : {
      name: 'John'
    }})
  console.log(`result: ${result}`)
 %}

GET https://examples.http-client.intellij.net

```

