• Preparing search index...
  • The search index is not available
UnixFS
  • UnixFS
  • ipfs-unixfs-exporter
  • recursive

Function recursive

  • recursive(path, blockstore, options?): AsyncGenerator<UnixFSEntry, void, any>
  • Returns an async iterator that yields all entries beneath a given CID or IPFS path, as well as the containing directory.

    Parameters

    • path: string | CID<unknown, number, number, Version>
    • blockstore: ReadableStorage
    • options: ExporterOptions = {}

    Returns AsyncGenerator<UnixFSEntry, void, any>

    Example

    import { recursive } from 'ipfs-unixfs-exporter'

    const entries = []

    for await (const child of recursive('Qmfoo/foo/bar', blockstore)) {
    entries.push(entry)
    }

    // entries contains all children of the `Qmfoo/foo/bar` directory and it's children
    • Defined in packages/ipfs-unixfs-exporter/src/index.ts:470

Settings

Member Visibility

Theme

UnixFS
  • Loading...

Generated using TypeDoc