SDK Reference
Auto-generated from the Pinner TypeScript SDK types. Each exported method and type is documented with signatures, parameters, return types, and examples.
This section is generated from TypeScript types. Do not edit these files directly — changes will be overwritten on the next build.
Installation
npm install @lumeweb/pinnerQuick Reference
| Module | Description |
|---|---|
Pinner | Main client class |
Upload | File, JSON, directory, and CAR uploads |
Pins | Pin management and status |
Websites | Website deployment and management |
IPNS | IPNS key management and publishing |
Adapters | Pinata v1/v2 compatibility adapters |
Errors | Error hierarchy and type guards |
Progress | Upload progress and cancellation |
Full SDK reference will be generated here from TypeScript types and TSDoc.