marked 16.0.0 → 16.1.0

package/lib/marked.d.ts

@@ -140,8 +140,8 @@ export declare namespace Tokens {
 		header: boolean;
 		align: "center" | "left" | "right" | null;
 	}
-	interface TableRow {
-		text: string;
+	interface TableRow<P = string> {
+		text: P;
 	}
 	interface Tag {
 		type: "html";
@@ -166,74 +166,74 @@ export type TokensList = Token[] & {
 /**
  * Renderer
  */
-declare class _Renderer {
-	options: MarkedOptions;
-	parser: _Parser;
-	constructor(options?: MarkedOptions);
-	space(token: Tokens.Space): string;
-	code({ text, lang, escaped }: Tokens.Code): string;
-	blockquote({ tokens }: Tokens.Blockquote): string;
-	html({ text }: Tokens.HTML | Tokens.Tag): string;
-	heading({ tokens, depth }: Tokens.Heading): string;
-	hr(token: Tokens.Hr): string;
-	list(token: Tokens.List): string;
-	listitem(item: Tokens.ListItem): string;
-	checkbox({ checked }: Tokens.Checkbox): string;
-	paragraph({ tokens }: Tokens.Paragraph): string;
-	table(token: Tokens.Table): string;
-	tablerow({ text }: Tokens.TableRow): string;
-	tablecell(token: Tokens.TableCell): string;
+declare class _Renderer<ParserOutput = string, RendererOutput = string> {
+	options: MarkedOptions<ParserOutput, RendererOutput>;
+	parser: _Parser<ParserOutput, RendererOutput>;
+	constructor(options?: MarkedOptions<ParserOutput, RendererOutput>);
+	space(token: Tokens.Space): RendererOutput;
+	code({ text, lang, escaped }: Tokens.Code): RendererOutput;
+	blockquote({ tokens }: Tokens.Blockquote): RendererOutput;
+	html({ text }: Tokens.HTML | Tokens.Tag): RendererOutput;
+	heading({ tokens, depth }: Tokens.Heading): RendererOutput;
+	hr(token: Tokens.Hr): RendererOutput;
+	list(token: Tokens.List): RendererOutput;
+	listitem(item: Tokens.ListItem): RendererOutput;
+	checkbox({ checked }: Tokens.Checkbox): RendererOutput;
+	paragraph({ tokens }: Tokens.Paragraph): RendererOutput;
+	table(token: Tokens.Table): RendererOutput;
+	tablerow({ text }: Tokens.TableRow<ParserOutput>): RendererOutput;
+	tablecell(token: Tokens.TableCell): RendererOutput;
 	/**
 	 * span level renderer
 	 */
-	strong({ tokens }: Tokens.Strong): string;
-	em({ tokens }: Tokens.Em): string;
-	codespan({ text }: Tokens.Codespan): string;
-	br(token: Tokens.Br): string;
-	del({ tokens }: Tokens.Del): string;
-	link({ href, title, tokens }: Tokens.Link): string;
-	image({ href, title, text, tokens }: Tokens.Image): string;
-	text(token: Tokens.Text | Tokens.Escape): string;
+	strong({ tokens }: Tokens.Strong): RendererOutput;
+	em({ tokens }: Tokens.Em): RendererOutput;
+	codespan({ text }: Tokens.Codespan): RendererOutput;
+	br(token: Tokens.Br): RendererOutput;
+	del({ tokens }: Tokens.Del): RendererOutput;
+	link({ href, title, tokens }: Tokens.Link): RendererOutput;
+	image({ href, title, text, tokens }: Tokens.Image): RendererOutput;
+	text(token: Tokens.Text | Tokens.Escape): RendererOutput;
 }
 /**
  * TextRenderer
  * returns only the textual part of the token
  */
-declare class _TextRenderer {
-	strong({ text }: Tokens.Strong): string;
-	em({ text }: Tokens.Em): string;
-	codespan({ text }: Tokens.Codespan): string;
-	del({ text }: Tokens.Del): string;
-	html({ text }: Tokens.HTML | Tokens.Tag): string;
-	text({ text }: Tokens.Text | Tokens.Escape | Tokens.Tag): string;
-	link({ text }: Tokens.Link): string;
-	image({ text }: Tokens.Image): string;
-	br(): string;
+declare class _TextRenderer<RendererOutput = string> {
+	strong({ text }: Tokens.Strong): RendererOutput;
+	em({ text }: Tokens.Em): RendererOutput;
+	codespan({ text }: Tokens.Codespan): RendererOutput;
+	del({ text }: Tokens.Del): RendererOutput;
+	html({ text }: Tokens.HTML | Tokens.Tag): RendererOutput;
+	text({ text }: Tokens.Text | Tokens.Escape | Tokens.Tag): RendererOutput;
+	link({ text }: Tokens.Link): RendererOutput;
+	image({ text }: Tokens.Image): RendererOutput;
+	br(): RendererOutput;
 }
 /**
  * Parsing & Compiling
  */
-declare class _Parser {
-	options: MarkedOptions;
-	renderer: _Renderer;
-	textRenderer: _TextRenderer;
-	constructor(options?: MarkedOptions);
+declare class _Parser<ParserOutput = string, RendererOutput = string> {
+	options: MarkedOptions<ParserOutput, RendererOutput>;
+	renderer: _Renderer<ParserOutput, RendererOutput>;
+	textRenderer: _TextRenderer<RendererOutput>;
+	constructor(options?: MarkedOptions<ParserOutput, RendererOutput>);
 	/**
 	 * Static Parse Method
 	 */
-	static parse(tokens: Token[], options?: MarkedOptions): string;
+	static parse<ParserOutput = string, RendererOutput = string>(tokens: Token[], options?: MarkedOptions<ParserOutput, RendererOutput>): ParserOutput;
 	/**
 	 * Static Parse Inline Method
 	 */
-	static parseInline(tokens: Token[], options?: MarkedOptions): string;
+	static parseInline<ParserOutput = string, RendererOutput = string>(tokens: Token[], options?: MarkedOptions<ParserOutput, RendererOutput>): ParserOutput;
 	/**
 	 * Parse Loop
 	 */
-	parse(tokens: Token[], top?: boolean): string;
+	parse(tokens: Token[], top?: boolean): ParserOutput;
 	/**
 	 * Parse Inline Tokens
 	 */
-	parseInline(tokens: Token[], renderer?: _Renderer | _TextRenderer): string;
+	parseInline(tokens: Token[], renderer?: _Renderer<ParserOutput, RendererOutput> | _TextRenderer<RendererOutput>): ParserOutput;
 }
 declare const other: {
 	codeRemoveIndent: RegExp;
@@ -339,11 +339,11 @@ export interface Rules {
 /**
  * Tokenizer
  */
-declare class _Tokenizer {
-	options: MarkedOptions;
+declare class _Tokenizer<ParserOutput = string, RendererOutput = string> {
+	options: MarkedOptions<ParserOutput, RendererOutput>;
 	rules: Rules;
-	lexer: _Lexer;
-	constructor(options?: MarkedOptions);
+	lexer: _Lexer<ParserOutput, RendererOutput>;
+	constructor(options?: MarkedOptions<ParserOutput, RendererOutput>);
 	space(src: string): Tokens.Space | undefined;
 	code(src: string): Tokens.Code | undefined;
 	fences(src: string): Tokens.Code | undefined;
@@ -369,10 +369,10 @@ declare class _Tokenizer {
 	url(src: string): Tokens.Link | undefined;
 	inlineText(src: string): Tokens.Text | undefined;
 }
-declare class _Hooks {
-	options: MarkedOptions;
+declare class _Hooks<ParserOutput = string, RendererOutput = string> {
+	options: MarkedOptions<ParserOutput, RendererOutput>;
 	block?: boolean;
-	constructor(options?: MarkedOptions);
+	constructor(options?: MarkedOptions<ParserOutput, RendererOutput>);
 	static passThroughHooks: Set<string>;
 	/**
 	 * Process markdown before marked
@@ -381,7 +381,7 @@ declare class _Hooks {
 	/**
 	 * Process HTML after marked is finished
 	 */
-	postprocess(html: string): string;
+	postprocess(html: ParserOutput): ParserOutput;
 	/**
 	 * Process all tokens before walk tokens
 	 */
@@ -393,7 +393,7 @@ declare class _Hooks {
 	/**
 	 * Provide function to parse tokens
 	 */
-	provideParser(): typeof _Parser.parse;
+	provideParser(): (tokens: Token[], options?: MarkedOptions<ParserOutput, RendererOutput> | undefined) => ParserOutput;
 }
 export interface TokenizerThis {
 	lexer: _Lexer;
@@ -407,28 +407,28 @@ export interface TokenizerExtension {
 	tokenizer: TokenizerExtensionFunction;
 	childTokens?: string[];
 }
-export interface RendererThis {
-	parser: _Parser;
+export interface RendererThis<ParserOutput = string, RendererOutput = string> {
+	parser: _Parser<ParserOutput, RendererOutput>;
 }
-export type RendererExtensionFunction = (this: RendererThis, token: Tokens.Generic) => string | false | undefined;
-export interface RendererExtension {
+export type RendererExtensionFunction<ParserOutput = string, RendererOutput = string> = (this: RendererThis<ParserOutput, RendererOutput>, token: Tokens.Generic) => RendererOutput | false | undefined;
+export interface RendererExtension<ParserOutput = string, RendererOutput = string> {
 	name: string;
-	renderer: RendererExtensionFunction;
+	renderer: RendererExtensionFunction<ParserOutput, RendererOutput>;
 }
-export type TokenizerAndRendererExtension = TokenizerExtension | RendererExtension | (TokenizerExtension & RendererExtension);
-export type HooksApi = Omit<_Hooks, "constructor" | "options" | "block">;
-export type HooksObject = {
-	[K in keyof HooksApi]?: (this: _Hooks, ...args: Parameters<HooksApi[K]>) => ReturnType<HooksApi[K]> | Promise<ReturnType<HooksApi[K]>>;
+export type TokenizerAndRendererExtension<ParserOutput = string, RendererOutput = string> = TokenizerExtension | RendererExtension<ParserOutput, RendererOutput> | (TokenizerExtension & RendererExtension<ParserOutput, RendererOutput>);
+export type HooksApi<ParserOutput = string, RendererOutput = string> = Omit<_Hooks<ParserOutput, RendererOutput>, "constructor" | "options" | "block">;
+export type HooksObject<ParserOutput = string, RendererOutput = string> = {
+	[K in keyof HooksApi<ParserOutput, RendererOutput>]?: (this: _Hooks<ParserOutput, RendererOutput>, ...args: Parameters<HooksApi<ParserOutput, RendererOutput>[K]>) => ReturnType<HooksApi<ParserOutput, RendererOutput>[K]> | Promise<ReturnType<HooksApi<ParserOutput, RendererOutput>[K]>>;
 };
-export type RendererApi = Omit<_Renderer, "constructor" | "options" | "parser">;
-export type RendererObject = {
-	[K in keyof RendererApi]?: (this: _Renderer, ...args: Parameters<RendererApi[K]>) => ReturnType<RendererApi[K]> | false;
+export type RendererApi<ParserOutput = string, RendererOutput = string> = Omit<_Renderer<ParserOutput, RendererOutput>, "constructor" | "options" | "parser">;
+export type RendererObject<ParserOutput = string, RendererOutput = string> = {
+	[K in keyof RendererApi<ParserOutput, RendererOutput>]?: (this: _Renderer<ParserOutput, RendererOutput>, ...args: Parameters<RendererApi<ParserOutput, RendererOutput>[K]>) => ReturnType<RendererApi<ParserOutput, RendererOutput>[K]> | false;
 };
-export type TokenizerApi = Omit<_Tokenizer, "constructor" | "options" | "rules" | "lexer">;
-export type TokenizerObject = {
-	[K in keyof TokenizerApi]?: (this: _Tokenizer, ...args: Parameters<TokenizerApi[K]>) => ReturnType<TokenizerApi[K]> | false;
+export type TokenizerApi<ParserOutput = string, RendererOutput = string> = Omit<_Tokenizer<ParserOutput, RendererOutput>, "constructor" | "options" | "rules" | "lexer">;
+export type TokenizerObject<ParserOutput = string, RendererOutput = string> = {
+	[K in keyof TokenizerApi<ParserOutput, RendererOutput>]?: (this: _Tokenizer<ParserOutput, RendererOutput>, ...args: Parameters<TokenizerApi<ParserOutput, RendererOutput>[K]>) => ReturnType<TokenizerApi<ParserOutput, RendererOutput>[K]> | false;
 };
-export interface MarkedExtension {
+export interface MarkedExtension<ParserOutput = string, RendererOutput = string> {
 	/**
 	 * True will tell marked to await any walkTokens functions before parsing the tokens and returning an HTML string.
 	 */
@@ -440,7 +440,7 @@ export interface MarkedExtension {
 	/**
 	 * Add tokenizers and renderers to marked
 	 */
-	extensions?: TokenizerAndRendererExtension[] | null;
+	extensions?: TokenizerAndRendererExtension<ParserOutput, RendererOutput>[] | null;
 	/**
 	 * Enable GitHub flavored markdown.
 	 */
@@ -453,7 +453,7 @@ export interface MarkedExtension {
 	 * provideLexer is called to provide a function to tokenize markdown.
 	 * provideParser is called to provide a function to parse tokens.
 	 */
-	hooks?: HooksObject | null;
+	hooks?: HooksObject<ParserOutput, RendererOutput> | null;
 	/**
 	 * Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.
 	 */
@@ -463,7 +463,7 @@ export interface MarkedExtension {
 	 *
 	 * An object containing functions to render tokens to HTML.
 	 */
-	renderer?: RendererObject | null;
+	renderer?: RendererObject<ParserOutput, RendererOutput> | null;
 	/**
 	 * Shows an HTML error message when rendering fails.
 	 */
@@ -480,27 +480,27 @@ export interface MarkedExtension {
 	 */
 	walkTokens?: ((token: Token) => void | Promise<void>) | null;
 }
-export interface MarkedOptions extends Omit<MarkedExtension, "hooks" | "renderer" | "tokenizer" | "extensions" | "walkTokens"> {
+export interface MarkedOptions<ParserOutput = string, RendererOutput = string> extends Omit<MarkedExtension<ParserOutput, RendererOutput>, "hooks" | "renderer" | "tokenizer" | "extensions" | "walkTokens"> {
 	/**
 	 * Hooks are methods that hook into some part of marked.
 	 */
-	hooks?: _Hooks | null;
+	hooks?: _Hooks<ParserOutput, RendererOutput> | null;
 	/**
 	 * Type: object Default: new Renderer()
 	 *
 	 * An object containing functions to render tokens to HTML.
 	 */
-	renderer?: _Renderer | null;
+	renderer?: _Renderer<ParserOutput, RendererOutput> | null;
 	/**
 	 * The tokenizer defines how to turn markdown text into tokens.
 	 */
-	tokenizer?: _Tokenizer | null;
+	tokenizer?: _Tokenizer<ParserOutput, RendererOutput> | null;
 	/**
 	 * Custom extensions
 	 */
 	extensions?: null | {
 		renderers: {
-			[name: string]: RendererExtensionFunction;
+			[name: string]: RendererExtensionFunction<ParserOutput, RendererOutput>;
 		};
 		childTokens: {
 			[name: string]: string[];
@@ -518,9 +518,9 @@ export interface MarkedOptions extends Omit<MarkedExtension, "hooks" | "renderer
 /**
  * Block Lexer
  */
-declare class _Lexer {
+declare class _Lexer<ParserOutput = string, RendererOutput = string> {
 	tokens: TokensList;
-	options: MarkedOptions;
+	options: MarkedOptions<ParserOutput, RendererOutput>;
 	state: {
 		inLink: boolean;
 		inRawBlock: boolean;
@@ -528,7 +528,7 @@ declare class _Lexer {
 	};
 	private tokenizer;
 	private inlineQueue;
-	constructor(options?: MarkedOptions);
+	constructor(options?: MarkedOptions<ParserOutput, RendererOutput>);
 	/**
 	 * Expose Rules
 	 */
@@ -582,11 +582,11 @@ declare class _Lexer {
 	/**
 	 * Static Lex Method
 	 */
-	static lex(src: string, options?: MarkedOptions): TokensList;
+	static lex<ParserOutput = string, RendererOutput = string>(src: string, options?: MarkedOptions<ParserOutput, RendererOutput>): TokensList;
 	/**
 	 * Static Lex Inline Method
 	 */
-	static lexInline(src: string, options?: MarkedOptions): Token[];
+	static lexInline<ParserOutput = string, RendererOutput = string>(src: string, options?: MarkedOptions<ParserOutput, RendererOutput>): Token[];
 	/**
 	 * Preprocessing
 	 */
@@ -605,45 +605,58 @@ declare class _Lexer {
 /**
  * Gets the original marked default options.
  */
-declare function _getDefaults(): MarkedOptions;
-declare let _defaults: MarkedOptions;
+declare function _getDefaults<ParserOutput = string, RendererOutput = string>(): MarkedOptions<ParserOutput, RendererOutput>;
+declare let _defaults: MarkedOptions<any, any>;
 export type MaybePromise = void | Promise<void>;
-export declare class Marked {
-	defaults: MarkedOptions;
-	options: (opt: MarkedOptions) => this;
+export declare class Marked<ParserOutput = string, RendererOutput = string> {
+	defaults: MarkedOptions<ParserOutput, RendererOutput>;
+	options: (opt: MarkedOptions<ParserOutput, RendererOutput>) => this;
 	parse: {
-		(src: string, options: MarkedOptions & {
+		(src: string, options: MarkedOptions<ParserOutput, RendererOutput> & {
 			async: true;
-		}): Promise<string>;
-		(src: string, options: MarkedOptions & {
+		}): Promise<ParserOutput>;
+		(src: string, options: MarkedOptions<ParserOutput, RendererOutput> & {
 			async: false;
-		}): string;
-		(src: string, options?: MarkedOptions | null): string | Promise<string>;
+		}): ParserOutput;
+		(src: string, options?: MarkedOptions<ParserOutput, RendererOutput> | null): ParserOutput | Promise<ParserOutput>;
 	};
 	parseInline: {
-		(src: string, options: MarkedOptions & {
+		(src: string, options: MarkedOptions<ParserOutput, RendererOutput> & {
 			async: true;
-		}): Promise<string>;
-		(src: string, options: MarkedOptions & {
+		}): Promise<ParserOutput>;
+		(src: string, options: MarkedOptions<ParserOutput, RendererOutput> & {
 			async: false;
-		}): string;
-		(src: string, options?: MarkedOptions | null): string | Promise<string>;
+		}): ParserOutput;
+		(src: string, options?: MarkedOptions<ParserOutput, RendererOutput> | null): ParserOutput | Promise<ParserOutput>;
+	};
+	Parser: {
+		new (options?: MarkedOptions<ParserOutput, RendererOutput> | undefined): _Parser<ParserOutput, RendererOutput>;
+		parse<ParserOutput_1 = string, RendererOutput_1 = string>(tokens: Token[], options?: MarkedOptions<ParserOutput_1, RendererOutput_1>): ParserOutput_1;
+		parseInline<ParserOutput_1 = string, RendererOutput_1 = string>(tokens: Token[], options?: MarkedOptions<ParserOutput_1, RendererOutput_1>): ParserOutput_1;
+	};
+	Renderer: {
+		new (options?: MarkedOptions<ParserOutput, RendererOutput> | undefined): _Renderer<ParserOutput, RendererOutput>;
+	};
+	TextRenderer: {
+		new (): _TextRenderer<RendererOutput>;
 	};
-	Parser: typeof _Parser;
-	Renderer: typeof _Renderer;
-	TextRenderer: typeof _TextRenderer;
 	Lexer: typeof _Lexer;
-	Tokenizer: typeof _Tokenizer;
-	Hooks: typeof _Hooks;
-	constructor(...args: MarkedExtension[]);
+	Tokenizer: {
+		new (options?: MarkedOptions<ParserOutput, RendererOutput> | undefined): _Tokenizer<ParserOutput, RendererOutput>;
+	};
+	Hooks: {
+		new (options?: MarkedOptions<ParserOutput, RendererOutput> | undefined): _Hooks<ParserOutput, RendererOutput>;
+		passThroughHooks: Set<string>;
+	};
+	constructor(...args: MarkedExtension<ParserOutput, RendererOutput>[]);
 	/**
 	 * Run callback for every token
 	 */
 	walkTokens(tokens: Token[] | TokensList, callback: (token: Token) => MaybePromise | MaybePromise[]): MaybePromise[];
-	use(...args: MarkedExtension[]): this;
-	setOptions(opt: MarkedOptions): this;
-	lexer(src: string, options?: MarkedOptions): TokensList;
-	parser(tokens: Token[], options?: MarkedOptions): string;
+	use(...args: MarkedExtension<ParserOutput, RendererOutput>[]): this;
+	setOptions(opt: MarkedOptions<ParserOutput, RendererOutput>): this;
+	lexer(src: string, options?: MarkedOptions<ParserOutput, RendererOutput>): TokensList;
+	parser(tokens: Token[], options?: MarkedOptions<ParserOutput, RendererOutput>): ParserOutput;
 	private parseMarkdown;
 	private onError;
 }
@@ -675,17 +688,17 @@ export declare namespace marked {
 	var options: (options: MarkedOptions) => typeof marked;
 	var setOptions: (options: MarkedOptions) => typeof marked;
 	var getDefaults: typeof _getDefaults;
-	var defaults: MarkedOptions;
+	var defaults: MarkedOptions<any, any>;
 	var use: (...args: MarkedExtension[]) => typeof marked;
 	var walkTokens: (tokens: Token[] | TokensList, callback: (token: Token) => MaybePromise | MaybePromise[]) => MaybePromise[];
 	var parseInline: {
-		(src: string, options: MarkedOptions & {
+		(src: string, options: MarkedOptions<string, string> & {
 			async: true;
 		}): Promise<string>;
-		(src: string, options: MarkedOptions & {
+		(src: string, options: MarkedOptions<string, string> & {
 			async: false;
 		}): string;
-		(src: string, options?: MarkedOptions | null): string | Promise<string>;
+		(src: string, options?: MarkedOptions<string, string> | null | undefined): string | Promise<string>;
 	};
 	var Parser: typeof _Parser;
 	var parser: typeof _Parser.parse;
@@ -702,13 +715,13 @@ export declare const setOptions: (options: MarkedOptions) => typeof marked;
 export declare const use: (...args: MarkedExtension[]) => typeof marked;
 export declare const walkTokens: (tokens: Token[] | TokensList, callback: (token: Token) => MaybePromise | MaybePromise[]) => MaybePromise[];
 export declare const parseInline: {
-	(src: string, options: MarkedOptions & {
+	(src: string, options: MarkedOptions<string, string> & {
 		async: true;
 	}): Promise<string>;
-	(src: string, options: MarkedOptions & {
+	(src: string, options: MarkedOptions<string, string> & {
 		async: false;
 	}): string;
-	(src: string, options?: MarkedOptions | null): string | Promise<string>;
+	(src: string, options?: MarkedOptions<string, string> | null | undefined): string | Promise<string>;
 };
 export declare const parse: typeof marked;
 export declare const parser: typeof _Parser.parse;