Skip to main content
Deno 2 is finally here 🎉️
Learn more

RFC1436 Gopher Client for Deno, with basic support for Gopher+

Example Usage

// Import the client.
import {GopherClient} from "https://deno.land/x/gopher/mod.ts";

// Create a new GopherClient, optionally specifying the protocol version to use.
const client = new GopherClient({
  ProtocolVersion: GopherProtocol.RFC1436,
});

// Download the Gopher server's menu.
const menu = await client.downloadMenu({
  Hostname: 'gopher.example.com',
  // Optional: Port (default 70)
  // Optional: Selector (e.g. "/foo")
});

// To display the menu items.
for (const menuItem of menu.Items) {
  console.log(menuItem.toString());
}

// To download a single menu item as a UInt8Array payload:
const bytes = client.downloadItem(menuItem);

// If it was a text entry (use the MenuItem.Type field to check) then you can
// easily convert to a string.
const text = new TextDecoder().decode(bytes);

Getting Gopher+ attributes

// Having previously obtained the menu item (see basic example), attributes can
// be set like so:
client.downloadAttributes(myMenuItem)
console.log(myMenuItem);

Results:

MenuItem {
  Type: "0",
  Name: "A file",
  Selector: "/a file.txt",
  Hostname: "gopher.example.com",
  Port: 70,
  Original: "0A file\t/a file.txt\tgopher.example.com\t70\t+",
  Attributes: Map {
    "ADMIN" => Map {
        "Admin" => "Foo Bar <foobar@example.com>",
        "Mod-Date" => "Sun Feb 21 20:19:18 2021 <20210221201918>"
      },
    "VIEWS" => Map { "text/plain" => "<1k>" }
  }
}