4chan-ts

4chan-ts

A modern and typed 4chan API wrapper written in TypeScript.

This package provides simple access to 4chan's public JSON API, supporting boards, threads, and posts with full type safety.

✨ Features

• 🌀 Supports all public endpoints of the 4chan API
• ⚡ Built in TypeScript for type safety and modern dev experience
• 🧪 Lightweight
• 🚀 Bun-first, Node/npm-compatible
• ⏱️ Configurable request timeout
• 📦 Conditional requests using If-Modified-Since

---

📦 Installation

Using Bun

bun add 4chan-ts

Using [NPM]

npm install 4chan-ts

Quick Start

import { FourChanClient } from "4chan-ts";

(async () => {
  const chan = new FourChanClient({ timeout: 15_000 });

  const { data, error } = await chan.getBoards();
  if (error) {
    console.error(error);
    return;
  }
  console.log(data); // const data: BoardList
})();

Reuse the same FourChanClient instance for repeated requests. It keeps the latest successful response and its Last-Modified value per endpoint, sends If-Modified-Since on later requests, and returns the cached data when 4chan responds with 304 Not Modified.