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

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

import { MarkdownRenderer } from '../rendering.types';
import { MarkdownEntry, RichTextEntry } from '../shared.types';
/**
 * A markdown entry for generating emojis.
 */
export interface EmojiEntry extends MarkdownEntry, RichTextEntry {
    /**
     * The emoji name.
     */
    emoji: string;
}
/**
 * The renderer for emoji entries.
 *
 * @param entry The emoji entry.
 * @param options Document-level render options.
 * @returns Emoji markdown content.
 */
export declare const emojiRenderer: MarkdownRenderer;
/**
 * Helper which creates an emoji entry.
 *
 * @param options Entry-level options for this element.
 * @returns an emoji entry
 */
export declare function emoji(content: EmojiEntry['emoji'], options?: Omit<EmojiEntry, 'emoji'>): EmojiEntry;