marked 13.0.3 → 14.1.0

package/lib/marked.d.cts

@@ -271,54 +271,6 @@ declare const inlineNormal: {
 	url: RegExp;
 };
 export type InlineKeys = keyof typeof inlineNormal;
-/**
- * exports
- */
-export declare const block: {
-	normal: {
-		blockquote: RegExp;
-		code: RegExp;
-		def: RegExp;
-		fences: RegExp;
-		heading: RegExp;
-		hr: RegExp;
-		html: RegExp;
-		lheading: RegExp;
-		list: RegExp;
-		newline: RegExp;
-		paragraph: RegExp;
-		table: RegExp;
-		text: RegExp;
-	};
-	gfm: Record<"code" | "blockquote" | "hr" | "html" | "table" | "text" | "heading" | "list" | "paragraph" | "def" | "fences" | "lheading" | "newline", RegExp>;
-	pedantic: Record<"code" | "blockquote" | "hr" | "html" | "table" | "text" | "heading" | "list" | "paragraph" | "def" | "fences" | "lheading" | "newline", RegExp>;
-};
-export declare const inline: {
-	normal: {
-		_backpedal: RegExp;
-		anyPunctuation: RegExp;
-		autolink: RegExp;
-		blockSkip: RegExp;
-		br: RegExp;
-		code: RegExp;
-		del: RegExp;
-		emStrongLDelim: RegExp;
-		emStrongRDelimAst: RegExp;
-		emStrongRDelimUnd: RegExp;
-		escape: RegExp;
-		link: RegExp;
-		nolink: RegExp;
-		punctuation: RegExp;
-		reflink: RegExp;
-		reflinkSearch: RegExp;
-		tag: RegExp;
-		text: RegExp;
-		url: RegExp;
-	};
-	gfm: Record<"link" | "code" | "url" | "br" | "del" | "text" | "escape" | "tag" | "reflink" | "autolink" | "nolink" | "_backpedal" | "anyPunctuation" | "blockSkip" | "emStrongLDelim" | "emStrongRDelimAst" | "emStrongRDelimUnd" | "punctuation" | "reflinkSearch", RegExp>;
-	breaks: Record<"link" | "code" | "url" | "br" | "del" | "text" | "escape" | "tag" | "reflink" | "autolink" | "nolink" | "_backpedal" | "anyPunctuation" | "blockSkip" | "emStrongLDelim" | "emStrongRDelimAst" | "emStrongRDelimUnd" | "punctuation" | "reflinkSearch", RegExp>;
-	pedantic: Record<"link" | "code" | "url" | "br" | "del" | "text" | "escape" | "tag" | "reflink" | "autolink" | "nolink" | "_backpedal" | "anyPunctuation" | "blockSkip" | "emStrongLDelim" | "emStrongRDelimAst" | "emStrongRDelimUnd" | "punctuation" | "reflinkSearch", RegExp>;
-};
 export interface Rules {
 	block: Record<BlockKeys, RegExp>;
 	inline: Record<InlineKeys, RegExp>;
@@ -358,6 +310,7 @@ declare class _Tokenizer {
 }
 declare class _Hooks {
 	options: MarkedOptions;
+	block: boolean | undefined;
 	constructor(options?: MarkedOptions);
 	static passThroughHooks: Set<string>;
 	/**
@@ -372,6 +325,14 @@ declare class _Hooks {
 	 * Process all tokens before walk tokens
 	 */
 	processAllTokens(tokens: Token[] | TokensList): Token[] | TokensList;
+	/**
+	 * Provide function to tokenize markdown
+	 */
+	provideLexer(): typeof _Lexer.lexInline;
+	/**
+	 * Provide function to parse tokens
+	 */
+	provideParser(): typeof _Parser.parse;
 }
 export interface TokenizerThis {
 	lexer: _Lexer;
@@ -394,7 +355,7 @@ export interface RendererExtension {
 	renderer: RendererExtensionFunction;
 }
 export type TokenizerAndRendererExtension = TokenizerExtension | RendererExtension | (TokenizerExtension & RendererExtension);
-export type HooksApi = Omit<_Hooks, "constructor" | "options">;
+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]>>;
 };
@@ -428,6 +389,8 @@ export interface MarkedExtension {
 	 * preprocess is called to process markdown before sending it to marked.
 	 * processAllTokens is called with the TokensList before walkTokens.
 	 * postprocess is called to process html after marked has finished parsing.
+	 * provideLexer is called to provide a function to tokenize markdown.
+	 * provideParser is called to provide a function to parse tokens.
 	 */
 	hooks?: HooksObject | undefined | null;
 	/**
@@ -455,13 +418,8 @@ export interface MarkedExtension {
 	 * The return value of the function is ignored.
 	 */
 	walkTokens?: ((token: Token) => void | Promise<void>) | undefined | null;
-	/**
-	 * Use the new renderer that accepts an object instead of individual parameters.
-	 * This option will be removed and default to true in the next major version.
-	 */
-	useNewRenderer?: boolean | undefined;
 }
-export interface MarkedOptions extends Omit<MarkedExtension, "useNewRenderer" | "hooks" | "renderer" | "tokenizer" | "extensions" | "walkTokens"> {
+export interface MarkedOptions extends Omit<MarkedExtension, "hooks" | "renderer" | "tokenizer" | "extensions" | "walkTokens"> {
 	/**
 	 * Hooks are methods that hook into some part of marked.
 	 */
@@ -590,11 +548,26 @@ declare function _getDefaults(): MarkedOptions;
 declare let _defaults: MarkedOptions;
 export type MaybePromise = void | Promise<void>;
 export declare class Marked {
-	#private;
 	defaults: MarkedOptions;
 	options: (opt: MarkedOptions) => this;
-	parse: (src: string, options?: MarkedOptions | undefined | null) => string | Promise<string>;
-	parseInline: (src: string, options?: MarkedOptions | undefined | null) => string | Promise<string>;
+	parse: {
+		(src: string, options: MarkedOptions & {
+			async: true;
+		}): Promise<string>;
+		(src: string, options: MarkedOptions & {
+			async: false;
+		}): string;
+		(src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
+	};
+	parseInline: {
+		(src: string, options: MarkedOptions & {
+			async: true;
+		}): Promise<string>;
+		(src: string, options: MarkedOptions & {
+			async: false;
+		}): string;
+		(src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
+	};
 	Parser: typeof _Parser;
 	Renderer: typeof _Renderer;
 	TextRenderer: typeof _TextRenderer;
@@ -610,6 +583,8 @@ export declare class Marked {
 	setOptions(opt: MarkedOptions): this;
 	lexer(src: string, options?: MarkedOptions): TokensList;
 	parser(tokens: Token[], options?: MarkedOptions): string;
+	private parseMarkdown;
+	private onError;
 }
 /**
  * Compiles markdown to HTML asynchronously.
@@ -628,7 +603,13 @@ export declare function marked(src: string, options: MarkedOptions & {
  * @param options Optional hash of options
  * @return String of compiled HTML. Will be a Promise of string if async is set to true by any extensions.
  */
-export declare function marked(src: string, options?: MarkedOptions): string | Promise<string>;
+export declare function marked(src: string, options: MarkedOptions & {
+	async: false;
+}): string;
+export declare function marked(src: string, options: MarkedOptions & {
+	async: true;
+}): Promise<string>;
+export declare function marked(src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
 export declare namespace marked {
 	var options: (options: MarkedOptions) => typeof marked;
 	var setOptions: (options: MarkedOptions) => typeof marked;
@@ -636,7 +617,15 @@ export declare namespace marked {
 	var defaults: MarkedOptions;
 	var use: (...args: MarkedExtension[]) => typeof marked;
 	var walkTokens: (tokens: Token[] | TokensList, callback: (token: Token) => MaybePromise | MaybePromise[]) => MaybePromise[];
-	var parseInline: (src: string, options?: MarkedOptions | undefined | null) => string | Promise<string>;
+	var parseInline: {
+		(src: string, options: MarkedOptions & {
+			async: true;
+		}): Promise<string>;
+		(src: string, options: MarkedOptions & {
+			async: false;
+		}): string;
+		(src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
+	};
 	var Parser: typeof _Parser;
 	var parser: typeof _Parser.parse;
 	var Renderer: typeof _Renderer;
@@ -651,7 +640,15 @@ export declare const options: (options: MarkedOptions) => typeof marked;
 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 | undefined | null) => string | Promise<string>;
+export declare const parseInline: {
+	(src: string, options: MarkedOptions & {
+		async: true;
+	}): Promise<string>;
+	(src: string, options: MarkedOptions & {
+		async: false;
+	}): string;
+	(src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
+};
 export declare const parse: typeof marked;
 export declare const parser: typeof _Parser.parse;
 export declare const lexer: typeof _Lexer.lex;

package/lib/marked.d.ts

@@ -271,54 +271,6 @@ declare const inlineNormal: {
 	url: RegExp;
 };
 export type InlineKeys = keyof typeof inlineNormal;
-/**
- * exports
- */
-export declare const block: {
-	normal: {
-		blockquote: RegExp;
-		code: RegExp;
-		def: RegExp;
-		fences: RegExp;
-		heading: RegExp;
-		hr: RegExp;
-		html: RegExp;
-		lheading: RegExp;
-		list: RegExp;
-		newline: RegExp;
-		paragraph: RegExp;
-		table: RegExp;
-		text: RegExp;
-	};
-	gfm: Record<"code" | "blockquote" | "hr" | "html" | "table" | "text" | "heading" | "list" | "paragraph" | "def" | "fences" | "lheading" | "newline", RegExp>;
-	pedantic: Record<"code" | "blockquote" | "hr" | "html" | "table" | "text" | "heading" | "list" | "paragraph" | "def" | "fences" | "lheading" | "newline", RegExp>;
-};
-export declare const inline: {
-	normal: {
-		_backpedal: RegExp;
-		anyPunctuation: RegExp;
-		autolink: RegExp;
-		blockSkip: RegExp;
-		br: RegExp;
-		code: RegExp;
-		del: RegExp;
-		emStrongLDelim: RegExp;
-		emStrongRDelimAst: RegExp;
-		emStrongRDelimUnd: RegExp;
-		escape: RegExp;
-		link: RegExp;
-		nolink: RegExp;
-		punctuation: RegExp;
-		reflink: RegExp;
-		reflinkSearch: RegExp;
-		tag: RegExp;
-		text: RegExp;
-		url: RegExp;
-	};
-	gfm: Record<"link" | "code" | "url" | "br" | "del" | "text" | "escape" | "tag" | "reflink" | "autolink" | "nolink" | "_backpedal" | "anyPunctuation" | "blockSkip" | "emStrongLDelim" | "emStrongRDelimAst" | "emStrongRDelimUnd" | "punctuation" | "reflinkSearch", RegExp>;
-	breaks: Record<"link" | "code" | "url" | "br" | "del" | "text" | "escape" | "tag" | "reflink" | "autolink" | "nolink" | "_backpedal" | "anyPunctuation" | "blockSkip" | "emStrongLDelim" | "emStrongRDelimAst" | "emStrongRDelimUnd" | "punctuation" | "reflinkSearch", RegExp>;
-	pedantic: Record<"link" | "code" | "url" | "br" | "del" | "text" | "escape" | "tag" | "reflink" | "autolink" | "nolink" | "_backpedal" | "anyPunctuation" | "blockSkip" | "emStrongLDelim" | "emStrongRDelimAst" | "emStrongRDelimUnd" | "punctuation" | "reflinkSearch", RegExp>;
-};
 export interface Rules {
 	block: Record<BlockKeys, RegExp>;
 	inline: Record<InlineKeys, RegExp>;
@@ -358,6 +310,7 @@ declare class _Tokenizer {
 }
 declare class _Hooks {
 	options: MarkedOptions;
+	block: boolean | undefined;
 	constructor(options?: MarkedOptions);
 	static passThroughHooks: Set<string>;
 	/**
@@ -372,6 +325,14 @@ declare class _Hooks {
 	 * Process all tokens before walk tokens
 	 */
 	processAllTokens(tokens: Token[] | TokensList): Token[] | TokensList;
+	/**
+	 * Provide function to tokenize markdown
+	 */
+	provideLexer(): typeof _Lexer.lexInline;
+	/**
+	 * Provide function to parse tokens
+	 */
+	provideParser(): typeof _Parser.parse;
 }
 export interface TokenizerThis {
 	lexer: _Lexer;
@@ -394,7 +355,7 @@ export interface RendererExtension {
 	renderer: RendererExtensionFunction;
 }
 export type TokenizerAndRendererExtension = TokenizerExtension | RendererExtension | (TokenizerExtension & RendererExtension);
-export type HooksApi = Omit<_Hooks, "constructor" | "options">;
+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]>>;
 };
@@ -428,6 +389,8 @@ export interface MarkedExtension {
 	 * preprocess is called to process markdown before sending it to marked.
 	 * processAllTokens is called with the TokensList before walkTokens.
 	 * postprocess is called to process html after marked has finished parsing.
+	 * provideLexer is called to provide a function to tokenize markdown.
+	 * provideParser is called to provide a function to parse tokens.
 	 */
 	hooks?: HooksObject | undefined | null;
 	/**
@@ -455,13 +418,8 @@ export interface MarkedExtension {
 	 * The return value of the function is ignored.
 	 */
 	walkTokens?: ((token: Token) => void | Promise<void>) | undefined | null;
-	/**
-	 * Use the new renderer that accepts an object instead of individual parameters.
-	 * This option will be removed and default to true in the next major version.
-	 */
-	useNewRenderer?: boolean | undefined;
 }
-export interface MarkedOptions extends Omit<MarkedExtension, "useNewRenderer" | "hooks" | "renderer" | "tokenizer" | "extensions" | "walkTokens"> {
+export interface MarkedOptions extends Omit<MarkedExtension, "hooks" | "renderer" | "tokenizer" | "extensions" | "walkTokens"> {
 	/**
 	 * Hooks are methods that hook into some part of marked.
 	 */
@@ -590,11 +548,26 @@ declare function _getDefaults(): MarkedOptions;
 declare let _defaults: MarkedOptions;
 export type MaybePromise = void | Promise<void>;
 export declare class Marked {
-	#private;
 	defaults: MarkedOptions;
 	options: (opt: MarkedOptions) => this;
-	parse: (src: string, options?: MarkedOptions | undefined | null) => string | Promise<string>;
-	parseInline: (src: string, options?: MarkedOptions | undefined | null) => string | Promise<string>;
+	parse: {
+		(src: string, options: MarkedOptions & {
+			async: true;
+		}): Promise<string>;
+		(src: string, options: MarkedOptions & {
+			async: false;
+		}): string;
+		(src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
+	};
+	parseInline: {
+		(src: string, options: MarkedOptions & {
+			async: true;
+		}): Promise<string>;
+		(src: string, options: MarkedOptions & {
+			async: false;
+		}): string;
+		(src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
+	};
 	Parser: typeof _Parser;
 	Renderer: typeof _Renderer;
 	TextRenderer: typeof _TextRenderer;
@@ -610,6 +583,8 @@ export declare class Marked {
 	setOptions(opt: MarkedOptions): this;
 	lexer(src: string, options?: MarkedOptions): TokensList;
 	parser(tokens: Token[], options?: MarkedOptions): string;
+	private parseMarkdown;
+	private onError;
 }
 /**
  * Compiles markdown to HTML asynchronously.
@@ -628,7 +603,13 @@ export declare function marked(src: string, options: MarkedOptions & {
  * @param options Optional hash of options
  * @return String of compiled HTML. Will be a Promise of string if async is set to true by any extensions.
  */
-export declare function marked(src: string, options?: MarkedOptions): string | Promise<string>;
+export declare function marked(src: string, options: MarkedOptions & {
+	async: false;
+}): string;
+export declare function marked(src: string, options: MarkedOptions & {
+	async: true;
+}): Promise<string>;
+export declare function marked(src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
 export declare namespace marked {
 	var options: (options: MarkedOptions) => typeof marked;
 	var setOptions: (options: MarkedOptions) => typeof marked;
@@ -636,7 +617,15 @@ export declare namespace marked {
 	var defaults: MarkedOptions;
 	var use: (...args: MarkedExtension[]) => typeof marked;
 	var walkTokens: (tokens: Token[] | TokensList, callback: (token: Token) => MaybePromise | MaybePromise[]) => MaybePromise[];
-	var parseInline: (src: string, options?: MarkedOptions | undefined | null) => string | Promise<string>;
+	var parseInline: {
+		(src: string, options: MarkedOptions & {
+			async: true;
+		}): Promise<string>;
+		(src: string, options: MarkedOptions & {
+			async: false;
+		}): string;
+		(src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
+	};
 	var Parser: typeof _Parser;
 	var parser: typeof _Parser.parse;
 	var Renderer: typeof _Renderer;
@@ -651,7 +640,15 @@ export declare const options: (options: MarkedOptions) => typeof marked;
 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 | undefined | null) => string | Promise<string>;
+export declare const parseInline: {
+	(src: string, options: MarkedOptions & {
+		async: true;
+	}): Promise<string>;
+	(src: string, options: MarkedOptions & {
+		async: false;
+	}): string;
+	(src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
+};
 export declare const parse: typeof marked;
 export declare const parser: typeof _Parser.parse;
 export declare const lexer: typeof _Lexer.lex;