| Type Alias | Description |
|---|
| PieceCID | PieceCID - A constrained CID type for Piece Commitments. This is implemented as a Link type which is made concrete by a CID. A PieceCID uses the raw codec (0x55) and the fr32-sha256-trunc254-padbintree multihash function (0x1011) which encodes the base content length (as padding) of the original piece, and the height of the merkle tree used to hash it. |
| Variable | Description |
|---|
| defaultResolvers | The default resolvers to use when resolving the piece URL |
| Function | Description |
|---|
| asPieceCID | Convert a PieceCID input (string or CID) to a validated CID This is the main function to use when accepting PieceCID inputs |
| calculate | Calculate the PieceCID (Piece Commitment) for a given data blob |
| calculateFromIterable | Calculate PieceCID from an async iterable of Uint8Array chunks. |
| chainResolver | Resolve the piece URL from the chain |
| createPieceCIDStream | Create a TransformStream that calculates PieceCID while streaming data through it This allows calculating PieceCID without buffering the entire data in memory |
| download | Download a piece from a URL. |
| downloadAndValidate | Download data from a URL, validate its PieceCID, and return as Uint8Array |
| filbeamResolver | Resolve the piece URL from the FilBeam CDN |
| findPieceOnProviders | Find the piece on the providers |
| getSize | Extract the raw (unpadded) size from a PieceCIDv2 |
| getSizeFromPieceCID | Extract the raw (unpadded) size from a PieceCIDv2 |
| hexToPieceCID | Convert a hex representation of a PieceCID to a PieceCID object |
| isPieceCID | Check if a CID is a valid PieceCIDv2 |
| parse | - |
| providersResolver | Resolve the piece URL from the providers |
| resolvePieceUrl | Resolve the piece URL from the available resolvers |
Re-exports createPieceUrl
Re-exports createPieceUrlPDP
