DefinitelyTyped/types/runmd/index.d.ts
Piotr Błażejewicz (Peter Blazejewicz) 0193d237cb
feat(runmd): new module definition (#46303)
- definition file
- tests

https://www.npmjs.com/package/runmd
https://github.com/broofa/runmd

Thanks!
2020-07-24 11:03:28 -07:00

26 lines
620 B
TypeScript

// 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;
/**
* name of output file
*/
outputName?: string;
/**
* if true, disables RunMD footer
*/
lame?: boolean;
}