@actions/http-client

Making GET requests

This feature allows you to make GET requests to retrieve data from a specified endpoint. The code sample demonstrates how to create an instance of HttpClient, make a GET request, and read the response body.

const { HttpClient } = require('@actions/http-client');
const httpClient = new HttpClient('my-user-agent');

async function getExample() {
  const response = await httpClient.get('https://api.example.com/data');
  const body = await response.readBody();
  console.log(body);
}

getExample();

Making POST requests

This feature allows you to make POST requests to send data to a specified endpoint. The code sample shows how to send a JSON payload with the appropriate headers and process the response.

const { HttpClient } = require('@actions/http-client');
const httpClient = new HttpClient('my-user-agent');

async function postExample() {
  const data = JSON.stringify({ key: 'value' });
  const headers = { 'Content-Type': 'application/json' };
  const response = await httpClient.post('https://api.example.com/submit', data, headers);
  const body = await response.readBody();
  console.log(body);
}

postExample();

Handling streams

This feature is useful for handling large amounts of data by streaming it directly to a file or another destination. The code sample demonstrates how to pipe the response from a GET request into a writable stream.

const { HttpClient } = require('@actions/http-client');
const fs = require('fs');
const httpClient = new HttpClient('my-user-agent');

async function streamExample() {
  const response = await httpClient.get('https://api.example.com/data');
  const stream = fs.createWriteStream('./data.txt');
  response.message.pipe(stream);
}

streamExample();