Certainly! Here's a simple documentation for the HttpService class for each module system: ESM, CommonJS, script, and module.

HttpService Class Documentation

The HttpService class provides a versatile utility for making HTTP requests in various module environments. It simplifies the process of sending HTTP requests to REST APIs and handling responses.

Table of Contents

1. Features
2. Installation
   • ESM (ECMAScript Modules)
   • CommonJS
   • Script (Browser)
   • Module (Browser)
3. Usage
   • Making a GET Request
   • Making a POST Request
   • Making a PUT Request
   • Making a DELETE Request
4. Examples
   • ESM Example
   • CommonJS Example
   • Script Example
   • Module Example
5. License

Features

• Support for different module systems: ESM, CommonJS, script, and module.
• Flexible and easy-to-use API for making GET, POST, PUT, and DELETE requests.
• Automatic JSON parsing of response data.
• Error handling and status code reporting.

Installation

ESM (ECMAScript Modules)

import HttpService from './path/to/HttpService.mjs'; // Adjust the path as needed
const httpService = new HttpService('https://api.example.com');

CommonJS

const HttpService = require('./path/to/HttpService.js'); // Adjust the path as needed
const httpService = new HttpService('https://api.example.com');

Script (Browser)

<script src="path/to/HttpService.js"></script> <!-- Adjust the path as needed -->
<script>
  const httpService = new HttpService('https://api.example.com');
</script>

Module (Browser)

<script type="module">
  import HttpService from './path/to/HttpService.mjs'; // Adjust the path as needed
  const httpService = new HttpService('https://api.example.com');
</script>

Usage

Making a GET Request

const response = await httpService.get('/endpoint', headers, queryParams);
console.log(response);

Making a POST Request

const data = { key: 'value' };
const response = await httpService.post('/endpoint', data, headers, queryParams);
console.log(response);

Making a PUT Request

const data = { key: 'value' };
const response = await httpService.put('/endpoint', data, headers, queryParams);
console.log(response);

Making a DELETE Request

const response = await httpService.delete('/endpoint', headers, queryParams);
console.log(response);

Examples

ESM Example

import HttpService from './path/to/HttpService.mjs'; // Adjust the path as needed

async function fetchData() {
  const httpService = new HttpService('https://api.example.com');
  const response = await httpService.get('/data', {}, { page: 1 });

  if (response.status === 200) {
    const data = response.body;
    console.log('Received data:', data);
  } else {
    console.error('Request failed with status code:', response.status);
  }
}

fetchData();

CommonJS Example

const HttpService = require('./path/to/HttpService.js'); // Adjust the path as needed

async function fetchData() {
  const httpService = new HttpService('https://api.example.com');
  const response = await httpService.get('/data', {}, { page: 1 });

  if (response.status === 200) {
    const data = response.body;
    console.log('Received data:', data);
  } else {
    console.error('Request failed with status code:', response.status);
  }
}

fetchData();

Script Example

<script src="path/to/HttpService.js"></script> <!-- Adjust the path as needed -->
<script>
  const { default: HttpService } = window.HttpService;
  const httpService = new HttpService('https://api.example.com');
  httpService.get('/data', {}, { page: 1 }).then((response) => {
    if (response.status === 200) {
      const data = response.body;
      console.log('Received data:', data);
    } else {
      console.error('Request failed with status code:', response.status);
    }
  });
</script>

Module Example

<script type="module">
  import HttpService from './path/to/HttpService.mjs'; // Adjust the path as needed
  const httpService = new HttpService('https://api.example.com');
  httpService.get('/data', {}, { page: 1 }).then((response) => {
    if (response.status === 200) {
      const data = response.body;
      console.log('Received data:', data);
    } else {
      console.error('Request failed with status code:', response.status);
    }
  });
</script>

License

This project is licensed under the MIT License - see the LICENSE file for details.

Feel free to customize this documentation with your own project details and usage examples as needed.