npf2html/build/src/link-block.d.ts

Converts Tumblr's Neue Post Format to plain HTML

import { VisualMedia } from './media';
import { Renderer } from './renderer';
/**
 * An NPF link type content block.
 *
 * @see https://www.tumblr.com/docs/npf#content-block-type-link
 *
 * @category Content
 */
export interface LinkBlock {
    type: 'link';
    /** The URL to use for the link block. */
    url: string;
    /** The title of where the link goes. */
    title?: string;
    /** The description of where the link goes. */
    description?: string;
    /** The author of the link's content. */
    author?: string;
    /** The name of the site being linked to. */
    site_name?: string;
    display_url?: string;
    /** An image media object to use as a "poster" for the link. */
    poster?: VisualMedia[];
}
/**
 * Convets {@link block} to HTML.
 *
 * @category Content
 */
export declare function renderLink(renderer: Renderer, block: LinkBlock): string;