Type Alias InternalBookTreeNodeType<Entry>

The base tree node type for BookTreeNode.

type InternalBookTreeNodeType<Entry> = {
    _isBookTreeNode: true;
    children: Record<string, BookTreeNode>;
    entry: Entry;
    fullUrlBreadcrumbs: ReadonlyArray<string>;
    manuallyAdded: boolean;
    urlBreadcrumb: string;
}

Type Parameters

Entry

Index

Properties

_isBookTreeNode children entry fullUrlBreadcrumbs manuallyAdded urlBreadcrumb

Properties

_isBookTreeNode

_isBookTreeNode: true

children

children: Record<string, BookTreeNode>

entry

entry: Entry

fullUrlBreadcrumbs

fullUrlBreadcrumbs: ReadonlyArray<string>

manuallyAdded

manuallyAdded: boolean

False when an entry has been added by traversing manually added parents. True when the entry was added as an explicit entry.

urlBreadcrumb

urlBreadcrumb: string

UrlBreadcrumb is different from entry.title because it's modified to support URLs.