Interface Exportable<T>

cid

depth

name

path

size

type

if (entry.type === 'file') {
  // access UnixFSFile properties safely
}

if (entry.type === 'directory') {
  // access UnixFSDirectory properties safely
}
Copy

content

• content(options?): AsyncGenerator<T, void, unknown>

• Parameters

  • Optional options: ExporterOptions

  Returns AsyncGenerator<T, void, unknown>

  Example: File content

  When entry is a file or a raw node, offset and/or length arguments can be passed to entry.content() to return slices of data:

  const length = 5
  const data = new Uint8Array(length)
  let offset = 0
  
  for await (const chunk of entry.content({
    offset: 0,
    length
  })) {
    data.set(chunk, offset)
    offset += chunk.length
  }
  
  // `data` contains the first 5 bytes of the file
  return data
  Copy

  Example: Directory content

  If entry is a directory, passing offset and/or length to entry.content() will limit the number of files returned from the directory.

  const entries = []
  
  for await (const entry of dir.content({
    offset: 0,
    length: 5
  })) {
    entries.push(entry)
  }
  
  // `entries` contains the first 5 files/directories in the directory
  Copy