azle-fetch

Custom fetch function for Azle framework with Inter-Canister Calls (ICP)

Installation

npm install azle-fetch

import azleFetch from "azle-fetch";
import { Some } from "azle";

// Example usage
const url = "https://example.com/api";
const inits = {
  method: "GET",
  transform: "your_transform_function",
  max_response_bytes: Some(200_000n),
};

const result = await azleFetch(url, inits);
console.log(result);

Parameters

• url: The URL to make the request.
• inits: Initialization options, including method, transform function, and others.

Response

The function returns a Promise with the following structure:

{
  status: number; // HTTP status code
  data: TData; // Response data, parsed JSON or any other type
  error: {
    message: string | null; // Error message, if any
  }
}

Examples

  fetchGithubProfile: query([text], Result(text, text), async (username) => {
    const { data, error } = await azleFetch<any>(
      `https://api.github.com/users/${username}`,
      {
        method: "GET",
        headers: {
          "Content-Type": "application/json, charset=utf-8",
        },
        max_response_bytes: None,
        cycles: 50_000_000n,
        transform: "transform",
      }
    );

License

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