123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725 |
- declare module "Tokens" {
- export type Token = (Tokens.Space | Tokens.Code | Tokens.Heading | Tokens.Table | Tokens.Hr | Tokens.Blockquote | Tokens.List | Tokens.ListItem | Tokens.Paragraph | Tokens.HTML | Tokens.Text | Tokens.Def | Tokens.Escape | Tokens.Tag | Tokens.Image | Tokens.Link | Tokens.Strong | Tokens.Em | Tokens.Codespan | Tokens.Br | Tokens.Del | Tokens.Generic) & {
- loose?: boolean;
- tokens?: Token[];
- };
- export namespace Tokens {
- interface Space {
- type: 'space';
- raw: string;
- }
- interface Code {
- type: 'code';
- raw: string;
- codeBlockStyle?: 'indented' | undefined;
- lang?: string | undefined;
- text: string;
- escaped?: boolean;
- }
- interface Heading {
- type: 'heading';
- raw: string;
- depth: number;
- text: string;
- tokens: Token[];
- }
- interface Table {
- type: 'table';
- raw: string;
- align: Array<'center' | 'left' | 'right' | null>;
- header: TableCell[];
- rows: TableCell[][];
- }
- interface TableCell {
- text: string;
- tokens?: Token[];
- }
- interface Hr {
- type: 'hr';
- raw: string;
- }
- interface Blockquote {
- type: 'blockquote';
- raw: string;
- text: string;
- tokens: Token[];
- }
- interface List {
- type: 'list';
- raw: string;
- ordered: boolean;
- start: number | '';
- loose: boolean;
- items: ListItem[];
- }
- interface ListItem {
- type: 'list_item';
- raw: string;
- task: boolean;
- checked?: boolean | undefined;
- loose: boolean;
- text: string;
- tokens?: Token[];
- }
- interface Paragraph {
- type: 'paragraph';
- raw: string;
- pre?: boolean | undefined;
- text: string;
- tokens: Token[];
- }
- interface HTML {
- type: 'html';
- raw: string;
- pre: boolean;
- text: string;
- block: boolean;
- }
- interface Text {
- type: 'text';
- raw: string;
- text: string;
- tokens?: Token[];
- }
- interface Def {
- type: 'def';
- raw: string;
- tag: string;
- href: string;
- title: string;
- }
- interface Escape {
- type: 'escape';
- raw: string;
- text: string;
- }
- interface Tag {
- type: 'text' | 'html';
- raw: string;
- inLink: boolean;
- inRawBlock: boolean;
- text: string;
- block: boolean;
- }
- interface Link {
- type: 'link';
- raw: string;
- href: string;
- title?: string | null;
- text: string;
- tokens: Token[];
- }
- interface Image {
- type: 'image';
- raw: string;
- href: string;
- title: string | null;
- text: string;
- }
- interface Strong {
- type: 'strong';
- raw: string;
- text: string;
- tokens: Token[];
- }
- interface Em {
- type: 'em';
- raw: string;
- text: string;
- tokens: Token[];
- }
- interface Codespan {
- type: 'codespan';
- raw: string;
- text: string;
- }
- interface Br {
- type: 'br';
- raw: string;
- }
- interface Del {
- type: 'del';
- raw: string;
- text: string;
- tokens: Token[];
- }
- interface Generic {
- [index: string]: any;
- type: string;
- raw: string;
- tokens?: Token[] | undefined;
- }
- }
- export type Links = Record<string, Pick<Tokens.Link | Tokens.Image, 'href' | 'title'>>;
- export type TokensList = Token[] & {
- links: Links;
- };
- }
- declare module "Tokenizer" {
- import type { _Lexer } from "Lexer";
- import type { Links, Tokens } from "Tokens";
- import type { MarkedOptions } from "MarkedOptions";
- /**
- * Tokenizer
- */
- export class _Tokenizer {
- options: MarkedOptions;
- rules: any;
- lexer: _Lexer;
- constructor(options?: MarkedOptions);
- space(src: string): Tokens.Space | undefined;
- code(src: string): Tokens.Code | undefined;
- fences(src: string): Tokens.Code | undefined;
- heading(src: string): Tokens.Heading | undefined;
- hr(src: string): Tokens.Hr | undefined;
- blockquote(src: string): Tokens.Blockquote | undefined;
- list(src: string): Tokens.List | undefined;
- html(src: string): Tokens.HTML | Tokens.Paragraph | undefined;
- def(src: string): Tokens.Def | undefined;
- table(src: string): Tokens.Table | undefined;
- lheading(src: string): Tokens.Heading | undefined;
- paragraph(src: string): Tokens.Paragraph | undefined;
- text(src: string): Tokens.Text | undefined;
- escape(src: string): Tokens.Escape | undefined;
- tag(src: string): Tokens.Tag | undefined;
- link(src: string): Tokens.Link | Tokens.Image | undefined;
- reflink(src: string, links: Links): Tokens.Link | Tokens.Image | Tokens.Text | undefined;
- emStrong(src: string, maskedSrc: string, prevChar?: string): Tokens.Em | Tokens.Strong | undefined;
- codespan(src: string): Tokens.Codespan | undefined;
- br(src: string): Tokens.Br | undefined;
- del(src: string): Tokens.Del | undefined;
- autolink(src: string, mangle: (cap: string) => string): Tokens.Link | undefined;
- url(src: string, mangle: (cap: string) => string): Tokens.Link | undefined;
- inlineText(src: string, smartypants: (cap: string) => string): Tokens.Text | undefined;
- }
- }
- declare module "rules" {
- export type Rule = RegExp | string;
- export interface Rules {
- [ruleName: string]: Pick<RegExp, 'exec'> | Rule | Rules;
- }
- type BlockRuleNames = 'newline' | 'code' | 'fences' | 'hr' | 'heading' | 'blockquote' | 'list' | 'html' | 'def' | 'lheading' | '_paragraph' | 'text' | '_label' | '_title' | 'bullet' | 'listItemStart' | '_tag' | '_comment' | 'paragraph' | 'uote';
- type BlockSubRuleNames = 'normal' | 'gfm' | 'pedantic';
- type InlineRuleNames = 'escape' | 'autolink' | 'tag' | 'link' | 'reflink' | 'nolink' | 'reflinkSearch' | 'code' | 'br' | 'text' | '_punctuation' | 'punctuation' | 'blockSkip' | 'escapedEmSt' | '_comment' | '_escapes' | '_scheme' | '_email' | '_attribute' | '_label' | '_href' | '_title' | 'strong' | '_extended_email' | '_backpedal';
- type InlineSubRuleNames = 'gfm' | 'emStrong' | 'normal' | 'pedantic' | 'breaks';
- /**
- * Block-Level Grammar
- */
- export const block: Record<BlockRuleNames, Rule> & Record<BlockSubRuleNames, Rules> & Rules;
- /**
- * Inline-Level Grammar
- */
- export const inline: Record<InlineRuleNames, Rule> & Record<InlineSubRuleNames, Rules> & Rules;
- }
- declare module "Lexer" {
- import type { Token, TokensList } from "Tokens";
- import type { MarkedOptions } from "MarkedOptions";
- import type { Rules } from "rules";
- /**
- * Block Lexer
- */
- export class _Lexer {
- tokens: TokensList;
- options: MarkedOptions;
- state: {
- inLink: boolean;
- inRawBlock: boolean;
- top: boolean;
- };
- private tokenizer;
- private inlineQueue;
- constructor(options?: MarkedOptions);
- /**
- * Expose Rules
- */
- static get rules(): Rules;
- /**
- * Static Lex Method
- */
- static lex(src: string, options?: MarkedOptions): TokensList;
- /**
- * Static Lex Inline Method
- */
- static lexInline(src: string, options?: MarkedOptions): Token[];
- /**
- * Preprocessing
- */
- lex(src: string): TokensList;
- /**
- * Lexing
- */
- blockTokens(src: string, tokens?: Token[]): Token[];
- blockTokens(src: string, tokens?: TokensList): TokensList;
- inline(src: string, tokens?: Token[]): Token[];
- /**
- * Lexing/Compiling
- */
- inlineTokens(src: string, tokens?: Token[]): Token[];
- }
- }
- declare module "TextRenderer" {
- /**
- * TextRenderer
- * returns only the textual part of the token
- */
- export class _TextRenderer {
- strong(text: string): string;
- em(text: string): string;
- codespan(text: string): string;
- del(text: string): string;
- html(text: string): string;
- text(text: string): string;
- link(href: string, title: string | null | undefined, text: string): string;
- image(href: string, title: string | null, text: string): string;
- br(): string;
- }
- }
- declare module "Slugger" {
- import type { SluggerOptions } from "MarkedOptions";
- /**
- * Slugger generates header id
- */
- export class _Slugger {
- seen: {
- [slugValue: string]: number;
- };
- constructor();
- serialize(value: string): string;
- /**
- * Finds the next safe (unique) slug to use
- */
- getNextSafeSlug(originalSlug: string, isDryRun: boolean | undefined): string;
- /**
- * Convert string to unique id
- */
- slug(value: string, options?: SluggerOptions): string;
- }
- }
- declare module "Instance" {
- import { _Lexer } from "Lexer";
- import { _Parser } from "Parser";
- import { _Hooks } from "Hooks";
- import { _Renderer } from "Renderer";
- import { _Tokenizer } from "Tokenizer";
- import { _TextRenderer } from "TextRenderer";
- import { _Slugger } from "Slugger";
- import type { MarkedExtension, MarkedOptions } from "MarkedOptions";
- import type { Token, TokensList } from "Tokens";
- export type ResultCallback = (error: Error | null, parseResult?: string) => undefined | void;
- export class Marked {
- #private;
- defaults: MarkedOptions;
- options: (opt: MarkedOptions) => this;
- parse: (src: string, optOrCallback?: MarkedOptions | ResultCallback | undefined | null, callback?: ResultCallback | undefined) => string | Promise<string | undefined> | undefined;
- parseInline: (src: string, optOrCallback?: MarkedOptions | ResultCallback | undefined | null, callback?: ResultCallback | undefined) => string | Promise<string | undefined> | undefined;
- Parser: typeof _Parser;
- parser: typeof _Parser.parse;
- Renderer: typeof _Renderer;
- TextRenderer: typeof _TextRenderer;
- Lexer: typeof _Lexer;
- lexer: typeof _Lexer.lex;
- Tokenizer: typeof _Tokenizer;
- Slugger: typeof _Slugger;
- Hooks: typeof _Hooks;
- constructor(...args: MarkedExtension[]);
- /**
- * Run callback for every token
- */
- walkTokens<T = void>(tokens: Token[] | TokensList, callback: (token: Token) => T | T[]): T[];
- use(...args: MarkedExtension[]): this;
- setOptions(opt: MarkedOptions): this;
- }
- }
- declare module "helpers" {
- import type { MarkedOptions } from "MarkedOptions";
- import type { ResultCallback } from "Instance";
- import type { Rule } from "rules";
- export function escape(html: string, encode?: boolean): string;
- export function unescape(html: string): string;
- export function edit(regex: Rule, opt?: string): {
- replace: (name: string | RegExp, val: string | RegExp) => any;
- getRegex: () => RegExp;
- };
- export function cleanUrl(sanitize: boolean | undefined, base: string | undefined | null, href: string): string | null;
- export function resolveUrl(base: string, href: string): string;
- export const noopTest: {
- exec: () => null;
- };
- export function splitCells(tableRow: string, count?: number): string[];
- /**
- * Remove trailing 'c's. Equivalent to str.replace(/c*$/, '').
- * /c*$/ is vulnerable to REDOS.
- *
- * @param str
- * @param c
- * @param invert Remove suffix of non-c chars instead. Default falsey.
- */
- export function rtrim(str: string, c: string, invert?: boolean): string;
- export function findClosingBracket(str: string, b: string): number;
- export function checkDeprecations(opt: MarkedOptions, callback?: ResultCallback): void;
- }
- declare module "Renderer" {
- import type { MarkedOptions } from "MarkedOptions";
- import type { _Slugger } from "Slugger";
- /**
- * Renderer
- */
- export class _Renderer {
- options: MarkedOptions;
- constructor(options?: MarkedOptions);
- code(code: string, infostring: string | undefined, escaped: boolean): string;
- blockquote(quote: string): string;
- html(html: string, block?: boolean): string;
- heading(text: string, level: number, raw: string, slugger: _Slugger): string;
- hr(): string;
- list(body: string, ordered: boolean, start: number | ''): string;
- listitem(text: string, task: boolean, checked: boolean): string;
- checkbox(checked: boolean): string;
- paragraph(text: string): string;
- table(header: string, body: string): string;
- tablerow(content: string): string;
- tablecell(content: string, flags: {
- header: boolean;
- align: 'center' | 'left' | 'right' | null;
- }): string;
- /**
- * span level renderer
- */
- strong(text: string): string;
- em(text: string): string;
- codespan(text: string): string;
- br(): string;
- del(text: string): string;
- link(href: string, title: string | null | undefined, text: string): string;
- image(href: string, title: string | null, text: string): string;
- text(text: string): string;
- }
- }
- declare module "Parser" {
- import { _Renderer } from "Renderer";
- import { _TextRenderer } from "TextRenderer";
- import { _Slugger } from "Slugger";
- import type { Token } from "Tokens";
- import type { MarkedOptions } from "MarkedOptions";
- /**
- * Parsing & Compiling
- */
- export class _Parser {
- options: MarkedOptions;
- renderer: _Renderer;
- textRenderer: _TextRenderer;
- slugger: _Slugger;
- constructor(options?: MarkedOptions);
- /**
- * Static Parse Method
- */
- static parse(tokens: Token[], options?: MarkedOptions): string;
- /**
- * Static Parse Inline Method
- */
- static parseInline(tokens: Token[], options?: MarkedOptions): string;
- /**
- * Parse Loop
- */
- parse(tokens: Token[], top?: boolean): string;
- /**
- * Parse Inline Tokens
- */
- parseInline(tokens: Token[], renderer?: _Renderer | _TextRenderer): string;
- }
- }
- declare module "MarkedOptions" {
- import type { Token, Tokens, TokensList } from "Tokens";
- import type { _Parser } from "Parser";
- import type { _Lexer } from "Lexer";
- import type { _Renderer } from "Renderer";
- import type { _Tokenizer } from "Tokenizer";
- export interface SluggerOptions {
- /** Generates the next unique slug without updating the internal accumulator. */
- dryrun?: boolean;
- }
- export interface TokenizerThis {
- lexer: _Lexer;
- }
- export interface TokenizerExtension {
- name: string;
- level: 'block' | 'inline';
- start?: ((this: TokenizerThis, src: string) => number | void) | undefined;
- tokenizer: (this: TokenizerThis, src: string, tokens: Token[] | TokensList) => Tokens.Generic | undefined;
- childTokens?: string[] | undefined;
- }
- export interface RendererThis {
- parser: _Parser;
- }
- export type RendererExtensionFunction = (this: RendererThis, token: Tokens.Generic) => string | false | undefined;
- export interface RendererExtension {
- name: string;
- renderer: RendererExtensionFunction;
- }
- export type TokenizerAndRendererExtension = TokenizerExtension | RendererExtension | (TokenizerExtension & RendererExtension);
- type RendererApi = Omit<_Renderer, 'constructor' | 'options'>;
- type RendererObject = {
- [K in keyof RendererApi]?: (...args: Parameters<RendererApi[K]>) => ReturnType<RendererApi[K]> | false;
- };
- type TokenizerApi = Omit<_Tokenizer, 'constructor' | 'options' | 'rules' | 'lexer'>;
- type TokenizerObject = {
- [K in keyof TokenizerApi]?: (...args: Parameters<TokenizerApi[K]>) => ReturnType<TokenizerApi[K]> | false;
- };
- export interface MarkedExtension {
- /**
- * True will tell marked to await any walkTokens functions before parsing the tokens and returning an HTML string.
- */
- async?: boolean;
- /**
- * A prefix URL for any relative link.
- * @deprecated Deprecated in v5.0.0 use marked-base-url to prefix url for any relative link.
- */
- baseUrl?: string | undefined | null;
- /**
- * Enable GFM line breaks. This option requires the gfm option to be true.
- */
- breaks?: boolean | undefined;
- /**
- * Add tokenizers and renderers to marked
- */
- extensions?: TokenizerAndRendererExtension[] | undefined | null;
- /**
- * Enable GitHub flavored markdown.
- */
- gfm?: boolean | undefined;
- /**
- * Include an id attribute when emitting headings.
- * @deprecated Deprecated in v5.0.0 use marked-gfm-heading-id to include an id attribute when emitting headings (h1, h2, h3, etc).
- */
- headerIds?: boolean | undefined;
- /**
- * Set the prefix for header tag ids.
- * @deprecated Deprecated in v5.0.0 use marked-gfm-heading-id to add a string to prefix the id attribute when emitting headings (h1, h2, h3, etc).
- */
- headerPrefix?: string | undefined;
- /**
- * A function to highlight code blocks. The function can either be
- * synchronous (returning a string) or asynchronous (callback invoked
- * with an error if any occurred during highlighting and a string
- * if highlighting was successful)
- * @deprecated Deprecated in v5.0.0 use marked-highlight to add highlighting to code blocks.
- */
- highlight?: ((code: string, lang: string | undefined, callback?: (error: Error, code?: string) => void) => string | void) | null;
- /**
- * Hooks are methods that hook into some part of marked.
- * preprocess is called to process markdown before sending it to marked.
- * postprocess is called to process html after marked has finished parsing.
- */
- hooks?: {
- preprocess: (markdown: string) => string | Promise<string>;
- postprocess: (html: string) => string | Promise<string>;
- options?: MarkedOptions;
- } | null;
- /**
- * Set the prefix for code block classes.
- * @deprecated Deprecated in v5.0.0 use marked-highlight to prefix the className in a <code> block. Useful for syntax highlighting.
- */
- langPrefix?: string | undefined;
- /**
- * Mangle autolinks (<email@domain.com>).
- * @deprecated Deprecated in v5.0.0 use marked-mangle to mangle email addresses.
- */
- mangle?: boolean | undefined;
- /**
- * Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.
- */
- pedantic?: boolean | undefined;
- /**
- * Type: object Default: new Renderer()
- *
- * An object containing functions to render tokens to HTML.
- */
- renderer?: RendererObject | undefined | null;
- /**
- * Sanitize the output. Ignore any HTML that has been input. If true, sanitize the HTML passed into markdownString with the sanitizer function.
- * @deprecated Warning: This feature is deprecated and it should NOT be used as it cannot be considered secure. Instead use a sanitize library, like DOMPurify (recommended), sanitize-html or insane on the output HTML!
- */
- sanitize?: boolean | undefined;
- /**
- * Optionally sanitize found HTML with a sanitizer function.
- * @deprecated A function to sanitize the HTML passed into markdownString.
- */
- sanitizer?: ((html: string) => string) | null;
- /**
- * Shows an HTML error message when rendering fails.
- */
- silent?: boolean | undefined;
- /**
- * Use smarter list behavior than the original markdown. May eventually be default with the old behavior moved into pedantic.
- */
- smartLists?: boolean | undefined;
- /**
- * Use "smart" typograhic punctuation for things like quotes and dashes.
- * @deprecated Deprecated in v5.0.0 use marked-smartypants to use "smart" typographic punctuation for things like quotes and dashes.
- */
- smartypants?: boolean | undefined;
- /**
- * The tokenizer defines how to turn markdown text into tokens.
- */
- tokenizer?: TokenizerObject | undefined | null;
- /**
- * The walkTokens function gets called with every token.
- * Child tokens are called before moving on to sibling tokens.
- * Each token is passed by reference so updates are persisted when passed to the parser.
- * The return value of the function is ignored.
- */
- walkTokens?: ((token: Token) => void | Promise<void>) | undefined | null;
- /**
- * Generate closing slash for self-closing tags (<br/> instead of <br>)
- * @deprecated Deprecated in v5.0.0 use marked-xhtml to emit self-closing HTML tags for void elements (<br/>, <img/>, etc.) with a "/" as required by XHTML.
- */
- xhtml?: boolean | undefined;
- }
- export interface MarkedOptions extends Omit<MarkedExtension, 'extensions' | 'renderer' | 'tokenizer' | 'walkTokens'> {
- /**
- * Type: object Default: new Renderer()
- *
- * An object containing functions to render tokens to HTML.
- */
- renderer?: Omit<_Renderer, 'constructor'> | undefined | null;
- /**
- * The tokenizer defines how to turn markdown text into tokens.
- */
- tokenizer?: Omit<_Tokenizer, 'constructor'> | undefined | null;
- /**
- * The walkTokens function gets called with every token.
- * Child tokens are called before moving on to sibling tokens.
- * Each token is passed by reference so updates are persisted when passed to the parser.
- * The return value of the function is ignored.
- */
- walkTokens?: ((token: Token) => void | Promise<void> | Array<void | Promise<void>>) | undefined | null;
- /**
- * Add tokenizers and renderers to marked
- */
- extensions?: (TokenizerAndRendererExtension[] & {
- renderers: Record<string, RendererExtensionFunction>;
- childTokens: Record<string, string[]>;
- block: any[];
- inline: any[];
- startBlock: Array<(this: TokenizerThis, src: string) => number | void>;
- startInline: Array<(this: TokenizerThis, src: string) => number | void>;
- }) | undefined | null;
- }
- }
- declare module "defaults" {
- import type { MarkedOptions } from "MarkedOptions";
- /**
- * Gets the original marked default options.
- */
- export function _getDefaults(): MarkedOptions;
- export let _defaults: MarkedOptions;
- export function changeDefaults(newDefaults: MarkedOptions): void;
- }
- declare module "Hooks" {
- import type { MarkedOptions } from "MarkedOptions";
- export class _Hooks {
- options: MarkedOptions;
- constructor(options?: MarkedOptions);
- static passThroughHooks: Set<string>;
- /**
- * Process markdown before marked
- */
- preprocess(markdown: string): string;
- /**
- * Process HTML after marked is finished
- */
- postprocess(html: string): string;
- }
- }
- declare module "marked" {
- import { _Lexer } from "Lexer";
- import { _Parser } from "Parser";
- import { _Tokenizer } from "Tokenizer";
- import { _Renderer } from "Renderer";
- import { _TextRenderer } from "TextRenderer";
- import { _Slugger } from "Slugger";
- import { _Hooks } from "Hooks";
- import { _getDefaults } from "defaults";
- import type { MarkedExtension, MarkedOptions } from "MarkedOptions";
- import type { Token, TokensList } from "Tokens";
- import type { ResultCallback } from "Instance";
- /**
- * Compiles markdown to HTML asynchronously.
- *
- * @param src String of markdown source to be compiled
- * @param options Hash of options, having async: true
- * @return Promise of string of compiled HTML
- */
- export function marked(src: string, options: MarkedOptions & {
- async: true;
- }): Promise<string>;
- /**
- * Compiles markdown to HTML synchronously.
- *
- * @param src String of markdown source to be compiled
- * @param options Optional hash of options
- * @return String of compiled HTML
- */
- export function marked(src: string, options?: MarkedOptions): string;
- /**
- * Compiles markdown to HTML asynchronously with a callback.
- *
- * @param src String of markdown source to be compiled
- * @param callback Function called when the markdownString has been fully parsed when using async highlighting
- */
- export function marked(src: string, callback: ResultCallback): void;
- /**
- * Compiles markdown to HTML asynchronously with a callback.
- *
- * @param src String of markdown source to be compiled
- * @param options Hash of options
- * @param callback Function called when the markdownString has been fully parsed when using async highlighting
- */
- export function marked(src: string, options: MarkedOptions, callback: ResultCallback): void;
- /**
- * Compiles markdown to HTML asynchronously with a callback.
- *
- * @param src String of markdown source to be compiled
- * @param options Hash of options
- * @param callback Function called when the markdownString has been fully parsed when using async highlighting
- */
- export namespace marked {
- var options: (options: MarkedOptions) => typeof marked;
- var setOptions: (options: MarkedOptions) => typeof marked;
- var getDefaults: typeof _getDefaults;
- var defaults: MarkedOptions;
- var use: (...args: MarkedExtension[]) => typeof marked;
- var walkTokens: <T = void>(tokens: Token[] | TokensList, callback: (token: Token) => T | T[]) => T[];
- var parseInline: (src: string, optOrCallback?: MarkedOptions | ResultCallback | null | undefined, callback?: ResultCallback | undefined) => string | Promise<string | undefined> | undefined;
- var Parser: typeof _Parser;
- var parser: typeof _Parser.parse;
- var Renderer: typeof _Renderer;
- var TextRenderer: typeof _TextRenderer;
- var Lexer: typeof _Lexer;
- var lexer: typeof _Lexer.lex;
- var Tokenizer: typeof _Tokenizer;
- var Slugger: typeof _Slugger;
- var Hooks: typeof _Hooks;
- var parse: typeof marked;
- }
- export const options: (options: MarkedOptions) => typeof marked;
- export const setOptions: (options: MarkedOptions) => typeof marked;
- export const use: (...args: MarkedExtension[]) => typeof marked;
- export const walkTokens: <T = void>(tokens: Token[] | TokensList, callback: (token: Token) => T | T[]) => T[];
- export const parseInline: (src: string, optOrCallback?: MarkedOptions | ResultCallback | null | undefined, callback?: ResultCallback | undefined) => string | Promise<string | undefined> | undefined;
- export const parse: typeof marked;
- export const parser: typeof _Parser.parse;
- export const lexer: typeof _Lexer.lex;
- export { _defaults as defaults, _getDefaults as getDefaults } from "defaults";
- export { _Lexer as Lexer } from "Lexer";
- export { _Parser as Parser } from "Parser";
- export { _Tokenizer as Tokenizer } from "Tokenizer";
- export { _Renderer as Renderer } from "Renderer";
- export { _TextRenderer as TextRenderer } from "TextRenderer";
- export { _Slugger as Slugger } from "Slugger";
- export { _Hooks as Hooks } from "Hooks";
- export { Marked } from "Instance";
- export type * from "MarkedOptions";
- export type * from "rules";
- export type * from "Tokens";
- }
|