js-ipfs-unixfs
    Preparing search index...

    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;
        name: string;
        node: PBNode;
        path: string;
        size: bigint;
        type: "directory";
        unixfs: UnixFS;
        entries(
            options?: ExportContentOptions,
        ): AsyncGenerator<UnixFSDirectoryEntry, void, unknown>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cid name node path size type unixfs

    Methods

    entries

    Properties

    cid: CID

    The CID of the entry

    name: string

    The name the entry is stored under within the directory

    node: PBNode
    path: string

    The path of the entry within the containing directory structure

    size: bigint

    This is the reported size of the entry - it is taken from the Tsize of the PBLink and may not be the same as the actual file size

    type: "directory"

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

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

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

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods