docx
    Preparing search index...

    Type Alias EstimatedPageNumbers

    The page each bookmark of a document starts on, and the number of pages of the document and of each of its sections, as a PageNumberEstimator works them out.

    type EstimatedPageNumbers = {
        bookmarkPageNumbers?: ReadonlyMap<string, number>;
        bookmarks: ReadonlyMap<string, string>;
        guesses?: readonly PageNumberGuess[];
        pageCount?: number;
        relativePositions?: ReadonlyMap<string, readonly (string | undefined)[]>;
        sectionPageCounts?: readonly (number | undefined)[];
    }
    Index
    bookmarkPageNumbers?: ReadonlyMap<string, number>

    The number of the page each bookmark starts on, as a number, such as 4, by the bookmark's name, which the page references to it with a number format of their own write in that format: PAGEREF Results \* roman writes "iv". Those to a bookmark that isn't in it are left blank.

    bookmarks: ReadonlyMap<string, string>

    The number of the page each bookmark starts on, as the page shows it, such as "3" or "iv", by the bookmark's name. The page references to a bookmark that isn't in it are left blank.

    guesses?: readonly PageNumberGuess[]

    Where the estimator guessed, when it was asked to lay out past what it can't lay out as Word does, as estimatePageNumbersWith({ guess: true }) from docx/layout is, in the order of the pages. The page numbers from the first of them on may not be Word's. Nothing of them is written into the document.

    pageCount?: number

    The number of pages of the document, which its NUMPAGES fields show. They are left blank without it

    relativePositions?: ReadonlyMap<string, readonly (string | undefined)[]>

    What each page reference with \p (useRelativePosition) in the body writes, by the name of the bookmark it refers to, in the order they are in the body: "above" or "below" when it is on the same page as the bookmark, and "on page" and the bookmark's page otherwise, such as "on page 4". Those it has nothing for are left blank, as are those in headers, footers and notes.

    sectionPageCounts?: readonly (number | undefined)[]

    The number of pages of each of the document's sections, in order, which the SECTIONPAGES fields in the section, and in headers and footers only on its pages, show. Those of a section whose number is undefined are left blank.