A node of a Folder-content tree

interface FolderChildNode {
    children: FolderChildNode[];
    depth: number;
    entries:
        | Document<object, DocumentConstructionContext>[]
        | CompendiumCollection[];
    folder: documents.Folder;
    root: boolean;
    visible: boolean;
}

Properties

children: FolderChildNode[]

Child nodes of this node

depth: number

This node's depth number in the tree

entries:
    | Document<object, DocumentConstructionContext>[]
    | CompendiumCollection[]

Loose contents in this node

The Folder document represented by this node

root: boolean

Whether this is the root node of a tree

visible: boolean

Whether the Folder is visible to the current User