mdfetch API Documentation - v1.0.0
    Preparing search index...

    Interface ConversionResult

    Complete result from reading and converting a URL. Contains the original URL, extracted content in multiple formats, and all associated metadata.

    interface ConversionResult {
        url: string;
        title: string;
        readableHTML: string;
        plainText: string;
        markdown: string;
        excerpt: string;
        byline: string;
        siteName: string;
        lang: string;
        dir: string;
        publishedTime: string;
        length: number;
    }
    Index

    Properties

    url: string

    Original URL that was fetched

    title: string

    Article title

    readableHTML: string

    Readable HTML extracted by Readability

    plainText: string

    Plain text version of the content

    markdown: string

    Markdown version of the content

    excerpt: string

    Article excerpt/summary

    byline: string

    Article author/byline

    siteName: string

    Name of the source website

    lang: string

    Language code (e.g., 'en')

    dir: string

    Text direction ('ltr' or 'rtl')

    publishedTime: string

    Publication timestamp

    length: number

    Estimated reading length in characters