Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.16 KB

README.md

File metadata and controls

43 lines (27 loc) · 1.16 KB
Raw

cloudflare-workers-unfurl

A tiny utility to get basic information about a URL on Cloudflare Workers using the built-in HTMLRewriter API.

Usage

npm install cloudflare-workers-unfurl

There are two exports: unfurl and handleUnfurlRequest.

unfurl is the main function that does the work. It takes a URL and returns a promise that resolves to an object with the following properties:

  • title: The title of the page
  • description: The description of the page
  • image: The URL of the social image
  • favicon: The URL of the favicon
import { unfurl } from "cloudflare-workers-unfurl";

const result = await unfurl("https://example.com");

result.title; // 'Example Domain'

handleUnfurlRequest is a function that takes a Request object and returns a promise that resolves to a Response object. It uses unfurl to get the information about the URL in the url query parameter of the request and returns it as JSON.

import { AutoRouter } from "itty-router";
import { handleUnfurlRequest } from "cloudflare-workers-unfurl";

const router = AutoRouter();

router.get("/unfurl", handleUnfurlRequest);

export default router;

License

MIT