Class MarkdownTextSplitter

A text splitter specifically designed for Markdown documents, attempting to preserve Markdown structure within chunks. This is a wrapper around Langchain's MarkdownTextSplitter.

Implements

TextSplitter

Index

Constructors

Methods

Constructors

constructor

new MarkdownTextSplitter(params: TextSplitterParams): MarkdownTextSplitter
Creates an instance of MarkdownTextSplitter.
Parameters
- params: TextSplitterParams
  Parameters for the text splitter.
  - chunkSize
    The maximum size of each text chunk.
  - chunkOverlap
    The amount of overlap between consecutive text chunks.
Returns MarkdownTextSplitter

Methods

splitText

splitText(text: string): Promise<string[]>
Splits the given Markdown text into chunks.
Parameters
- text: string
  The input Markdown text to be split.
Returns Promise<string[]>
A promise that resolves to an array of string chunks.

Implementation of TextSplitter.splitText