Skip to content
LogoLogo

This page is auto-generated from TypeDoc. Do not edit directly. To update, modify the TypeScript source in @lumeweb/pinner and run pnpm generate:sdk.

Install

npm install @lumeweb/pinner

Quick Start

import { Pinner } from "@lumeweb/pinner";
 
const client = new Pinner({
  authToken: process.env.PINNER_AUTH_TOKEN!,
});
 
// Upload a file
const result = await client.upload(file);
console.log(result.cid);

Classes

ClassDescription
IpnsClientClient for managing IPNS keys and publishing content to IPNS names.
WebsitesClientClient for managing websites hosted on IPFS with custom domains and SSL.
Pinner
UploadManagerHandles file uploads via XHR or TUS protocol based on file size.

Errors

All SDK errors extend PinnerError. See Error Classes for the full hierarchy.

Types

36 interfaces and 34 type aliases. See Types for full definitions.