js-ipfs-unixfs
    Preparing search index...

    Interface IdentityNode

    Entries with a identity codec CID return identity entries.

    These are entries where the data payload is stored in the CID itself, otherwise they are identical to RawNodes.

    interface IdentityNode {
        cid: CID;
        name: string;
        node: Uint8Array;
        path: string;
        size: bigint;
        type: "identity";
        content(
            options?: ExportContentOptions,
        ): AsyncGenerator<Uint8Array<ArrayBufferLike>, void, unknown>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cid name node path size type

    Methods

    content

    Properties

    cid: CID

    The CID of the entry

    name: string

    The name the entry is stored under within the directory

    node: Uint8Array
    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: "identity"

    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
    }

    Methods

    content

    Settings

    Member Visibility

    On This Page

    Properties
    Methods