Options
All
  • Public
  • Public/Protected
  • All
Menu

Module lib

A client library for the https://nft.storage/ service. It provides a convenient interface for working with the Raw HTTP API from a web browser or Node.js and comes bundled with TS for out-of-the box type inference and better IntelliSense.

example
import { NFTStorage, File, Blob } from "nft.storage"
const client = new NFTStorage({ token: API_TOKEN })

const cid = await client.storeBlob(new Blob(['hello world']))

Index

Namespaces

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

BlockstoreI

BlockstoreI: Blockstore

Type Parameters

    CIDString

    CIDString: lib/interface

    Type Parameters

      CarReader

      CarReader: lib/interface

      Type Parameters

        Deal

        Deal: lib/interface

        Type Parameters

          FileObject

          FileObject: lib/interface

          Type Parameters

            FilesSource

            FilesSource: lib/interface

            Type Parameters

              Pin

              Pin: lib/interface

              Type Parameters

                RateLimiter

                RateLimiter: lib/interface

                Type Parameters

                  RequestOptions

                  RequestOptions: lib/interface

                  Type Parameters

                    Service

                    Service: lib/interface

                    Type Parameters

                      TokenType

                      TokenType<T>: lib/interface

                      Type Parameters

                      • T

                      Variables

                      Blob

                      Blob: typeof Blob

                      File

                      File: typeof File

                      FormData

                      FormData: typeof FormData

                      Functions

                      createRateLimiter

                      toAsyncIterable

                      • toAsyncIterable<T>(iterable: Iterable<T>): AsyncIterable<T>

                      • Cast an iterable to an asyncIterable

                        Type Parameters

                        • T

                        Parameters

                        • iterable: Iterable<T>

                        Returns AsyncIterable<T>

                      toGatewayURL

                      Generated using TypeDoc