ts-markdown/dist/renderers/primitives.d.ts

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

import { MarkdownRenderer } from '../rendering.types';
import { RichTextEntry } from '../shared.types';
/**
 * A markdown entry for generating a plain string.
 * This is the most fundamental entry type.
 */
export interface String extends RichTextEntry {
}
/**
 * The renderer for string entries.
 *
 * @param entry A string of text.
 * @returns String content.
 */
export declare const stringRenderer: MarkdownRenderer;
/**
 * The renderer for null entries.
 *
 * @param entry null
 * @returns an empty string
 */
export declare const nullRenderer: MarkdownRenderer;
/**
 * The renderer for undefined entries.
 *
 * @param entry undefined
 * @returns an empty string
 */
export declare const undefinedRenderer: MarkdownRenderer;
/**
 * The renderer for boolean entries.
 *
 * @param entry a boolean
 * @returns the boolean as a string
 */
export declare const booleanRenderer: MarkdownRenderer;
/**
 * The renderer for number entries.
 *
 * @param entry a number
 * @returns the number as a string
 */
export declare const numberRenderer: MarkdownRenderer;
/**
 * The renderer for bigint entries.
 *
 * @param entry a bigint
 * @returns the bigint as a string
 */
export declare const bigintRenderer: MarkdownRenderer;
/**
 * The renderer for date entries.
 *
 * @param entry a date
 * @returns the date as an ISO string.
 */
export declare const dateRenderer: MarkdownRenderer;