markmv - v1.41.7
    Preparing search index...

    Class LineBasedSplitStrategy

    Split strategy that divides content at specific line numbers.

    Allows precise splitting at user-specified line numbers. This is useful when you know exactly where you want to split a document, perhaps based on analysis or external requirements.

    Line-based splitting

      const strategy = new LineBasedSplitStrategy({
          splitLines: [100, 250, 400],  // Split at these line numbers
          outputDir: './sections/',
          filenamePattern: 'section-{index}'
      });

      const result = await strategy.split(content, 'document.md');
      console.log(`Split at lines: ${strategy.options.splitLines?.join(', ')}`);

    Hierarchy (View Summary)

    Index
    constructor
    options
    extractFrontmatter extractTitleFromHeader generateFilename getHeaderLevel isTargetHeader sanitizeFilename split numberOrDefault stringOrDefault
    options: SplitStrategyOptions

    The effective options for this strategy: the supplied options layered over the defaults set in the constructor.

    • Separates a leading frontmatter block from the rest of the content.

      Parameters

      • content: string

        The full file content.

      Returns { content: string; frontmatter: string }

      The split content.

      • content: string

        The content following the frontmatter, or the whole input when there is none.

      • frontmatter: string

        The leading --- delimited block including its delimiters, or an empty string when there is none.

    • Generates a filename for a section from the filenamePattern option.

      {title} is replaced by the sanitised title (or section-N when that is empty), {index} by the one-based index and {original} by the original filename without its extension. The original file's extension is appended, defaulting to .md.

      Parameters

      • title: string

        The section title.

      • index: number

        The zero-based position of the section.

      • originalFilename: string

        The name of the file being split.

      Returns string

      The generated filename.

    • Returns the header level of a line.

      Parameters

      • line: string

        The line to inspect.

      Returns number

      The number of leading # characters when the line is a header (the markers followed by whitespace or the end of the line), otherwise 0.

    • Checks whether a line is a header of exactly the given level.

      Parameters

      • line: string

        The line to inspect.

      • targetLevel: number

        The header level to match.

      Returns boolean

      True when the line's header level equals targetLevel; headers of other levels do not match.

    • Converts a string into a filename-safe slug.

      The text is lower-cased, characters other than letters, digits, spaces and hyphens are removed, whitespace becomes hyphens, repeated and surrounding hyphens are collapsed, and the result is limited to 50 characters.

      Parameters

      • str: string

        The text to convert.

      Returns string

      The slug, which may be empty.

    • Splits before each one-based line number in the splitLines option.

      Line numbers are de-duplicated and sorted, and numbering counts lines after the frontmatter. A number below 1 or beyond the last line produces a warning; a number only slightly past the end is treated as the last line. Sections containing only whitespace are skipped. Each section is titled by its first header, otherwise by the first few words of its first suitable line, otherwise by its starting line. With no splitLines, an error is recorded and the whole original content is returned as remaining content. When no valid line remains, the content is returned as a single section.

      Parameters

      • content: string

        The full content of the file to split, including any frontmatter.

      • originalFilename: string

        The name of the file being split, used when generating section filenames.

      Returns Promise<SplitResult>

      The sections, with the frontmatter as remaining content when preserveFrontmatter is on.

    • Returns value unless it is nullish or zero, in which case fallback is used, since zero is not a meaningful value for these options (header levels start at 1, size limits must be positive).

      Parameters

      • value: number | undefined
      • fallback: number

      Returns number

    • Returns value unless it is nullish or the empty string, in which case fallback is used, an empty string is treated as "no value supplied" rather than a meaningful value to preserve.

      Parameters

      • value: string | null | undefined
      • fallback: string

      Returns string

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods