Interface UnixFSDirectory

If the entry is a directory, entry.entries() returns further entry objects:

if (entry.type === 'directory') {
  for await (const entry of dir.content()) {
    console.info(entry.name)
  }
}

interface UnixFSDirectory {
    cid: CID;
    node: PBNode;
    type: "directory";
    unixfs: UnixFS;
    entries(
        options?: ExporterOptions,
    ): AsyncGenerator<UnixFSDirectoryEntry, void, unknown>;
}

Hierarchy (View Summary)

Exportable
- UnixFSDirectory

Index

Properties

cid node type unixfs

Methods

entries

Properties

cid

cid: CID

The CID of the entry

node

node: PBNode

type

type: "directory"

A disambiguator to allow TypeScript to work out the type of the entry.

Example

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

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

unixfs

unixfs: UnixFS

Methods

entries

entries(
options?: ExporterOptions,
): AsyncGenerator<UnixFSDirectoryEntry, void, unknown>
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
```
Parameters
- Optionaloptions: ExporterOptions
Returns AsyncGenerator<UnixFSDirectoryEntry, void, unknown>
- Defined in packages/ipfs-unixfs-exporter/src/index.ts:286

Interface UnixFSDirectory

Hierarchy (View Summary)

Index

Properties

Methods

Properties

cid

node

type

Example

unixfs

Methods

entries

Parameters

Returns AsyncGenerator<UnixFSDirectoryEntry, void, unknown>

Settings

On This Page