filecoin-pin/dist/core/data-set/get-data-set-pieces.d.ts

Bridge IPFS content to Filecoin Onchain Cloud using familiar tools

/**
 * Get Data Set Pieces
 *
 * Functions for retrieving pieces from a dataset with optional metadata enrichment.
 *
 * @module core/data-set/get-data-set-pieces
 */
import { type StorageContext, type Synapse } from '@filoz/synapse-sdk';
import type { DataSetPiecesResult, GetDataSetPiecesOptions } from './types.js';
/**
 * Get all pieces for a dataset from a StorageContext
 *
 * This function uses the StorageContext.getPieces() async generator to retrieve
 * all pieces in a dataset. Optionally fetches metadata for each piece from WarmStorage.
 *
 * Example usage:
 * ```typescript
 * const result = await getDataSetPieces(storageContext, {
 *   includeMetadata: true,
 *   batchSize: 100
 * })
 *
 * console.log(`Found ${result.pieces.length} pieces`)
 * for (const piece of result.pieces) {
 *   console.log(`  ${piece.pieceCid}`)
 *   if (piece.rootIpfsCid) {
 *     console.log(`    IPFS: ${piece.rootIpfsCid}`)
 *   }
 * }
 * ```
 *
 * @param storageContext - Storage context from upload or dataset resolution
 * @param options - Optional configuration
 * @returns Pieces and warnings
 */
export declare function getDataSetPieces(synapse: Synapse, storageContext: StorageContext, options?: GetDataSetPiecesOptions): Promise<DataSetPiecesResult>;
//# sourceMappingURL=get-data-set-pieces.d.ts.map