@types/runmd v1.3.3

Installation

npm install --save @types/runmd

Summary

This package contains type definitions for runmd (https://github.com/broofa/runmd).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/runmd.

index.d.ts

// Type definitions for runmd 1.3
// Project: https://github.com/broofa/runmd
// Definitions by: Piotr Błażejewicz <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/**
 * Render RunMD-compatible markdown file
 * @param inputText - text to transform
 */
export function render(inputText: string, options?: Options): string;

export interface Options {
    /**
     * name of input file
     */
    inputName?: string | undefined;
    /**
     * name of output file
     */
    outputName?: string | undefined;
    /**
     * if true, disables RunMD footer
     */
    lame?: boolean | undefined;
}

Additional Details

• Last updated: Thu, 08 Jul 2021 22:42:15 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Piotr Błażejewicz.