filecoin-pin
Version:
Bridge IPFS content to Filecoin Onchain Cloud using familiar tools
31 lines • 1.01 kB
TypeScript
/**
* List Data Sets
*
* Functions for listing and summarizing datasets with optional provider enrichment.
*
* @module core/data-set/list-data-sets
*/
import type { Synapse } from '@filoz/synapse-sdk';
import type { DataSetSummary, ListDataSetsOptions } from './types.js';
/**
* List all datasets for an address with optional provider enrichment
*
* Example usage:
* ```typescript
* const synapse = await Synapse.create({ privateKey, rpcURL })
* const datasets = await listDataSets(synapse)
*
* for (const ds of datasets) {
* console.log(`Dataset ${ds.dataSetId}: ${ds.currentPieceCount} pieces`)
* if (ds.provider) {
* console.log(` Provider: ${ds.provider.name}`)
* }
* }
* ```
*
* @param synapse - Initialized Synapse instance
* @param options - Optional configuration
* @returns Array of dataset summaries
*/
export declare function listDataSets(synapse: Synapse, options?: ListDataSetsOptions): Promise<DataSetSummary[]>;
//# sourceMappingURL=list-data-sets.d.ts.map