ts-markdown/dist.browser/renderers/strikethrough.d.ts

An extensible TypeScript markdown generator that takes JSON and creates a markdown document.

import { MarkdownRenderer } from '../rendering.types';
import { RichTextEntry, MarkdownEntry } from '../shared.types';
/**
 * A markdown entry for strikethrough text.
 */
export interface StrikethroughEntry extends MarkdownEntry, RichTextEntry {
    /**
     * The strikethrough text contents and identifying property for the renderer.
     */
    strikethrough: RichTextEntry;
}
/**
 * The renderer for strickethrough text entries.
 *
 * @param entry The strikethrough entry.
 * @param options Document-level render options.
 * @returns Strikethrough markdown content.
 */
export declare const strikethroughRenderer: MarkdownRenderer;
/**
 * Helper which creates a strikethrough text entry.
 *
 * @param options Entry-level options for this element.
 * @returns a strikethrough text entry
 */
export declare function strikethrough(content: StrikethroughEntry['strikethrough'], options?: Omit<StrikethroughEntry, 'strikethrough'>): StrikethroughEntry;