Configuration

API Overview

The @cognipeer/to-markdown library provides a simple yet powerful API for converting various file formats to Markdown.

Core Functions

convertToMarkdown

Main function for converting files to Markdown format.

function convertToMarkdown(
  input: ConverterInput,
  options?: ConverterOptions
): Promise<string>

Parameters:

input: File path (string), base64 data (string), or Buffer
options: Optional configuration object

Returns: Promise that resolves to Markdown string

Example:

const markdown = await convertToMarkdown('./document.pdf');

saveToMarkdownFile

Saves converted Markdown content to a file.

function saveToMarkdownFile(
  content: string,
  fileName: string,
  outputDir?: string
): Promise<string>

Parameters:

content: The Markdown content to save
fileName: Name for the output file (without .md extension)
outputDir: Directory to save the file (default: “output”)

Returns: Promise that resolves to the file path

Example:

await saveToMarkdownFile(markdown, 'document', './output');

Type Definitions

ConverterInput

Union type for input formats:

type ConverterInput = string | Buffer;

ConverterOptions

Configuration options for conversion:

interface ConverterOptions {
  fileName?: string;        // File name for buffer inputs
  forceExtension?: string;  // Force specific file extension
  url?: string;            // Original URL (for web content)
}

FileExtension

Enum of supported file extensions:

enum FileExtension {
  PDF = '.pdf',
  DOCX = '.docx',
  HTML = '.html',
  // ... and more
}