webFetch

Read text content from HTTP/HTTPS/file sources using webFetch from the system module.

import { webFetch } from "system";

Table of Contents

• webFetch(urlOrPath)
  • Parameters
  • Return Value
  • Errors
  • Example: Fetch Web JSON
  • Example: Read Local File (Relative)
  • Example: Read Local File (file://)

webFetch(urlOrPath)

Fetches text from:

• http://...
• https://...
• file://...
• local file paths

Relative local paths are resolved from the widget entry script directory.

Parameters

• urlOrPath
  • Type: string
  • Required: Yes
  • Description: URL or filesystem path to load.

Return Value

• Type: string | null
• Description: Fetched text on success, otherwise null.

Errors

• Throws a TypeError when urlOrPath is missing or invalid/empty.

Example: Fetch Web JSON

import { webFetch } from "system";

const text = webFetch("https://api.github.com");
if (text !== null) {
  console.log("length:", text.length);
}

Example: Read Local File (Relative)

import { webFetch } from "system";

const text = webFetch("./data/config.json");
if (text !== null) {
  console.log(text);
}

Example: Read Local File (file://)

import { webFetch } from "system";

const text = webFetch("file:///C:/Temp/sample.txt");
console.log(text);