markmv - v1.41.7
    Preparing search index...

    Interface TocResult

    Result of a TOC generation operation.

    interface TocResult {
        fileDetails: {
            file: string;
            headingsFound: number;
            position: string;
            tocGenerated: boolean;
            tocLength: number;
        }[];
        fileErrors: { error: string; file: string }[];
        filesModified: number;
        filesProcessed: number;
        filesSkipped: number;
        processingTime: number;
    }
    Index
    fileDetails fileErrors filesModified filesProcessed filesSkipped processingTime
    fileDetails: {
        file: string;
        headingsFound: number;
        position: string;
        tocGenerated: boolean;
        tocLength: number;
    }[]

    Details of each file processed

    Type Declaration

    • file: string

      Path of the processed file

    • headingsFound: number

      Number of headings found in the file

    • position: string

      Where the table of contents was placed, or none when no headings were found

    • tocGenerated: boolean

      Whether a table of contents was generated for the file

    • tocLength: number

      Length of the generated table of contents, in characters

    fileErrors: { error: string; file: string }[]

    Files that had processing errors

    Type Declaration

    • error: string

      Error message

    • file: string

      Path of the file that failed to process

    filesModified: number

    Number of files modified

    filesProcessed: number

    Number of files processed

    filesSkipped: number

    Number of files skipped (no headings)

    processingTime: number

    Processing time in milliseconds

    Settings
    Member Visibility

    On This Page
    Properties