marked

marked

Version 16.4.1
Published 13 days ago
428 kB
No dependencies
MIT license

Install

npm i marked

yarn add marked

pnpm add marked

Overview

A markdown parser built for speed

Index

Variables

variable blockNormal

const blockNormal: {
    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;
};

variable defaults

let defaults: MarkedOptions<any, any>;

variable inlineNormal

const inlineNormal: {
    _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;
};

variable lexer

const lexer: <ParserOutput = string, RendererOutput = string>(
    src: string,
    options?: MarkedOptions<ParserOutput, RendererOutput>
) => TokensList;

variable other

const other: {
    codeRemoveIndent: RegExp;
    outputLinkReplace: RegExp;
    indentCodeCompensation: RegExp;
    beginningSpace: RegExp;
    endingHash: RegExp;
    startingSpaceChar: RegExp;
    endingSpaceChar: RegExp;
    nonSpaceChar: RegExp;
    newLineCharGlobal: RegExp;
    tabCharGlobal: RegExp;
    multipleSpaceGlobal: RegExp;
    blankLine: RegExp;
    doubleBlankLine: RegExp;
    blockquoteStart: RegExp;
    blockquoteSetextReplace: RegExp;
    blockquoteSetextReplace2: RegExp;
    listReplaceTabs: RegExp;
    listReplaceNesting: RegExp;
    listIsTask: RegExp;
    listReplaceTask: RegExp;
    anyLine: RegExp;
    hrefBrackets: RegExp;
    tableDelimiter: RegExp;
    tableAlignChars: RegExp;
    tableRowBlankLine: RegExp;
    tableAlignRight: RegExp;
    tableAlignCenter: RegExp;
    tableAlignLeft: RegExp;
    startATag: RegExp;
    endATag: RegExp;
    startPreScriptTag: RegExp;
    endPreScriptTag: RegExp;
    startAngleBracket: RegExp;
    endAngleBracket: RegExp;
    pedanticHrefTitle: RegExp;
    unicodeAlphaNumeric: RegExp;
    escapeTest: RegExp;
    escapeReplace: RegExp;
    escapeTestNoEncode: RegExp;
    escapeReplaceNoEncode: RegExp;
    unescapeTest: RegExp;
    caret: RegExp;
    percentDecode: RegExp;
    findPipe: RegExp;
    splitPipe: RegExp;
    slashPipe: RegExp;
    carriageReturn: RegExp;
    spaceLine: RegExp;
    notSpaceStart: RegExp;
    endingNewline: RegExp;
    listItemRegex: (bull: string) => RegExp;
    nextBulletRegex: (indent: number) => RegExp;
    hrRegex: (indent: number) => RegExp;
    fencesBeginRegex: (indent: number) => RegExp;
    headingBeginRegex: (indent: number) => RegExp;
    htmlBeginRegex: (indent: number) => RegExp;
};

variable parse

const parse: typeof marked;

variable parseInline

const parseInline: {
    (
        src: string,
        options: MarkedOptions<string, string> & { async: true }
    ): Promise<string>;
    (src: string, options: MarkedOptions<string, string> & { async: false }): string;
    (src: string, options?: MarkedOptions<string, string> | null | undefined):
        | string
        | Promise<string>;
};

variable parser

const parser: <ParserOutput = string, RendererOutput = string>(
    tokens: Token[],
    options?: MarkedOptions<ParserOutput, RendererOutput>
) => ParserOutput;

Functions

function getDefaults

getDefaults: <ParserOutput = string, RendererOutput = string>() => MarkedOptions<
    ParserOutput,
    RendererOutput
>;

Gets the original marked default options.

function marked

marked: typeof marked;

Compiles markdown to HTML asynchronously.
Parameter src
String of markdown source to be compiled
Parameter options
Hash of options, having async: true Promise of string of compiled HTML
Compiles markdown to HTML.
Parameter src
String of markdown source to be compiled
Parameter options
Optional hash of options String of compiled HTML. Will be a Promise of string if async is set to true by any extensions.

function options

options: (options: MarkedOptions) => typeof marked;

function setOptions

setOptions: (options: MarkedOptions) => typeof marked;

function use

use: (...args: MarkedExtension[]) => typeof marked;

function walkTokens

walkTokens: (
    tokens: Token[] | TokensList,
    callback: (token: Token) => MaybePromise | MaybePromise[]
) => MaybePromise[];

Classes

class Hooks

class _Hooks<ParserOutput = string, RendererOutput = string> {}

constructor

constructor(options?: MarkedOptions<ParserOutput, RendererOutput>);

property block

block?: boolean;

property options

options: MarkedOptions<ParserOutput, RendererOutput>;

property passThroughHooks

static passThroughHooks: Set<string>;

property passThroughHooksRespectAsync

static passThroughHooksRespectAsync: Set<string>;

method emStrongMask

emStrongMask: (src: string) => string;

Mask contents that should not be interpreted as em/strong delimiters

method postprocess

postprocess: (html: ParserOutput) => ParserOutput;

Process HTML after marked is finished

method preprocess

preprocess: (markdown: string) => string;

Process markdown before marked

method processAllTokens

processAllTokens: (tokens: Token[] | TokensList) => Token[] | TokensList;

Process all tokens before walk tokens

method provideLexer

provideLexer: () => typeof _Lexer.lexInline;

Provide function to tokenize markdown

method provideParser

provideParser: () => (
    tokens: Token[],
    options?: MarkedOptions<ParserOutput, RendererOutput> | undefined
) => ParserOutput;

Provide function to parse tokens

class Lexer

class _Lexer<ParserOutput = string, RendererOutput = string> {}

Block Lexer

constructor

constructor(options?: MarkedOptions<ParserOutput, RendererOutput>);

property options

options: MarkedOptions<ParserOutput, RendererOutput>;

property rules

static readonly rules: {
    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'
            | 'def'
            | 'heading'
            | 'list'
            | 'paragraph'
            | 'fences'
            | 'lheading'
            | 'newline',
            RegExp
        >;
        pedantic: Record<
            | 'code'
            | 'blockquote'
            | 'hr'
            | 'html'
            | 'table'
            | 'text'
            | 'def'
            | 'heading'
            | 'list'
            | 'paragraph'
            | 'fences'
            | 'lheading'
            | 'newline',
            RegExp
        >;
    };
    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'
            | 'nolink'
            | '_backpedal'
            | 'anyPunctuation'
            | 'autolink'
            | 'blockSkip'
            | 'emStrongLDelim'
            | 'emStrongRDelimAst'
            | 'emStrongRDelimUnd'
            | 'punctuation'
            | 'reflinkSearch',
            RegExp
        >;
        breaks: Record<
            | 'link'
            | 'code'
            | 'url'
            | 'br'
            | 'del'
            | 'text'
            | 'escape'
            | 'tag'
            | 'reflink'
            | 'nolink'
            | '_backpedal'
            | 'anyPunctuation'
            | 'autolink'
            | 'blockSkip'
            | 'emStrongLDelim'
            | 'emStrongRDelimAst'
            | 'emStrongRDelimUnd'
            | 'punctuation'
            | 'reflinkSearch',
            RegExp
        >;
        pedantic: Record<
            | 'link'
            | 'code'
            | 'url'
            | 'br'
            | 'del'
            | 'text'
            | 'escape'
            | 'tag'
            | 'reflink'
            | 'nolink'
            | '_backpedal'
            | 'anyPunctuation'
            | 'autolink'
            | 'blockSkip'
            | 'emStrongLDelim'
            | 'emStrongRDelimAst'
            | 'emStrongRDelimUnd'
            | 'punctuation'
            | 'reflinkSearch',
            RegExp
        >;
    };
};

Expose Rules

property state

state: { inLink: boolean; inRawBlock: boolean; top: boolean };

property tokens

tokens: Token[] & { links: Links };

method blockTokens

blockTokens: {
    (src: string, tokens?: Token[], lastParagraphClipped?: boolean): Token[];
    (
        src: string,
        tokens?: TokensList,
        lastParagraphClipped?: boolean
    ): TokensList;
};

Lexing

method inline

inline: (src: string, tokens?: Token[]) => Token[];

method inlineTokens

inlineTokens: (src: string, tokens?: Token[]) => Token[];

Lexing/Compiling

method lex

static lex: <ParserOutput = string, RendererOutput = string>(
    src: string,
    options?: MarkedOptions<ParserOutput, RendererOutput>
) => TokensList;

Static Lex Method
Preprocessing

method lexInline

static lexInline: <ParserOutput = string, RendererOutput = string>(
    src: string,
    options?: MarkedOptions<ParserOutput, RendererOutput>
) => Token[];

Static Lex Inline Method

class Marked

class Marked<ParserOutput = string, RendererOutput = string> {}

constructor

constructor(...args: MarkedExtension<ParserOutput, RendererOutput>[]);

property defaults

defaults: MarkedOptions<ParserOutput, RendererOutput>;

property Hooks

Hooks: {
    new (
        options?: MarkedOptions<ParserOutput, RendererOutput> | undefined
    ): _Hooks<ParserOutput, RendererOutput>;
    passThroughHooks: Set<string>;
    passThroughHooksRespectAsync: Set<string>;
};

property Lexer

Lexer: typeof _Lexer;

property options

options: (opt: MarkedOptions<ParserOutput, RendererOutput>) => this;

property parse

parse: {
    (
        src: string,
        options: MarkedOptions<ParserOutput, RendererOutput> & { async: true }
    ): Promise<ParserOutput>;
    (
        src: string,
        options: MarkedOptions<ParserOutput, RendererOutput> & { async: false }
    ): ParserOutput;
    (src: string, options?: MarkedOptions<ParserOutput, RendererOutput> | null):
        | ParserOutput
        | Promise<ParserOutput>;
};

property parseInline

parseInline: {
    (
        src: string,
        options: MarkedOptions<ParserOutput, RendererOutput> & { async: true }
    ): Promise<ParserOutput>;
    (
        src: string,
        options: MarkedOptions<ParserOutput, RendererOutput> & { async: false }
    ): ParserOutput;
    (src: string, options?: MarkedOptions<ParserOutput, RendererOutput> | null):
        | ParserOutput
        | Promise<ParserOutput>;
};

property Parser

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;
};

property Renderer

Renderer: new (
    options?: MarkedOptions<ParserOutput, RendererOutput> | undefined
) => _Renderer<ParserOutput, RendererOutput>;

property TextRenderer

TextRenderer: new () => _TextRenderer<RendererOutput>;

property Tokenizer

Tokenizer: new (
    options?: MarkedOptions<ParserOutput, RendererOutput> | undefined
) => _Tokenizer<ParserOutput, RendererOutput>;

method lexer

lexer: (
    src: string,
    options?: MarkedOptions<ParserOutput, RendererOutput>
) => TokensList;

method parser

parser: (
    tokens: Token[],
    options?: MarkedOptions<ParserOutput, RendererOutput>
) => ParserOutput;

method setOptions

setOptions: (opt: MarkedOptions<ParserOutput, RendererOutput>) => this;

method use

use: (...args: MarkedExtension<ParserOutput, RendererOutput>[]) => this;

method walkTokens

walkTokens: (
    tokens: Token[] | TokensList,
    callback: (token: Token) => MaybePromise | MaybePromise[]
) => MaybePromise[];

Run callback for every token

class Parser

class _Parser<ParserOutput = string, RendererOutput = string> {}

Parsing & Compiling

constructor

constructor(options?: MarkedOptions<ParserOutput, RendererOutput>);

property options

options: MarkedOptions<ParserOutput, RendererOutput>;

property renderer

renderer: _Renderer<ParserOutput, RendererOutput>;

property textRenderer

textRenderer: _TextRenderer<RendererOutput>;

method parse

static parse: <ParserOutput = string, RendererOutput = string>(
    tokens: Token[],
    options?: MarkedOptions<ParserOutput, RendererOutput>
) => ParserOutput;

Static Parse Method
Parse Loop

method parseInline

static parseInline: <ParserOutput = string, RendererOutput = string>(
    tokens: Token[],
    options?: MarkedOptions<ParserOutput, RendererOutput>
) => ParserOutput;

Static Parse Inline Method
Parse Inline Tokens

class Renderer

class _Renderer<ParserOutput = string, RendererOutput = string> {}

Renderer

constructor

constructor(options?: MarkedOptions<ParserOutput, RendererOutput>);

property options

options: MarkedOptions<ParserOutput, RendererOutput>;

property parser

parser: _Parser<ParserOutput, RendererOutput>;

method blockquote

blockquote: ({ tokens }: Tokens.Blockquote) => RendererOutput;

method br

br: (token: Tokens.Br) => RendererOutput;

method checkbox

checkbox: ({ checked }: Tokens.Checkbox) => RendererOutput;

method code

code: ({ text, lang, escaped }: Tokens.Code) => RendererOutput;

method codespan

codespan: ({ text }: Tokens.Codespan) => RendererOutput;

method def

def: (token: Tokens.Def) => RendererOutput;

method del

del: ({ tokens }: Tokens.Del) => RendererOutput;

method em

em: ({ tokens }: Tokens.Em) => RendererOutput;

method heading

heading: ({ tokens, depth }: Tokens.Heading) => RendererOutput;

method hr

hr: (token: Tokens.Hr) => RendererOutput;

method html

html: ({ text }: Tokens.HTML | Tokens.Tag) => RendererOutput;

method image

image: ({ href, title, text, tokens }: Tokens.Image) => RendererOutput;

method link

link: ({ href, title, tokens }: Tokens.Link) => RendererOutput;

method list

list: (token: Tokens.List) => RendererOutput;

method listitem

listitem: (item: Tokens.ListItem) => RendererOutput;

method paragraph

paragraph: ({ tokens }: Tokens.Paragraph) => RendererOutput;

method space

space: (token: Tokens.Space) => RendererOutput;

method strong

strong: ({ tokens }: Tokens.Strong) => RendererOutput;

span level renderer

method table

table: (token: Tokens.Table) => RendererOutput;

method tablecell

tablecell: (token: Tokens.TableCell) => RendererOutput;

method tablerow

tablerow: ({ text }: Tokens.TableRow<ParserOutput>) => RendererOutput;

method text

text: (token: Tokens.Text | Tokens.Escape) => RendererOutput;

class TextRenderer

class _TextRenderer<RendererOutput = string> {}

TextRenderer returns only the textual part of the token

method br

br: () => RendererOutput;

method codespan

codespan: ({ text }: Tokens.Codespan) => RendererOutput;

method del

del: ({ text }: Tokens.Del) => RendererOutput;

method em

em: ({ text }: Tokens.Em) => RendererOutput;

method html

html: ({ text }: Tokens.HTML | Tokens.Tag) => RendererOutput;

method image

image: ({ text }: Tokens.Image) => RendererOutput;

method link

link: ({ text }: Tokens.Link) => RendererOutput;

method strong

strong: ({ text }: Tokens.Strong) => RendererOutput;

method text

text: ({ text }: Tokens.Text | Tokens.Escape | Tokens.Tag) => RendererOutput;

class Tokenizer

class _Tokenizer<ParserOutput = string, RendererOutput = string> {}

Tokenizer

constructor

constructor(options?: MarkedOptions<ParserOutput, RendererOutput>);

property lexer

lexer: _Lexer<ParserOutput, RendererOutput>;

property options

options: MarkedOptions<ParserOutput, RendererOutput>;

property rules

rules: Rules;

method autolink

autolink: (src: string) => Tokens.Link | undefined;

method blockquote

blockquote: (src: string) => Tokens.Blockquote | undefined;

method br

br: (src: string) => Tokens.Br | undefined;

method code

code: (src: string) => Tokens.Code | undefined;

method codespan

codespan: (src: string) => Tokens.Codespan | undefined;

method def

def: (src: string) => Tokens.Def | undefined;

method del

del: (src: string) => Tokens.Del | undefined;

method emStrong

emStrong: (
    src: string,
    maskedSrc: string,
    prevChar?: string
) => Tokens.Em | Tokens.Strong | undefined;

method escape

escape: (src: string) => Tokens.Escape | undefined;

method fences

fences: (src: string) => Tokens.Code | undefined;

method heading

heading: (src: string) => Tokens.Heading | undefined;

method hr

hr: (src: string) => Tokens.Hr | undefined;

method html

html: (src: string) => Tokens.HTML | undefined;

method inlineText

inlineText: (src: string) => Tokens.Text | undefined;

method lheading

lheading: (src: string) => Tokens.Heading | undefined;

method link

link: (src: string) => Tokens.Link | Tokens.Image | undefined;

method list

list: (src: string) => Tokens.List | undefined;

method paragraph

paragraph: (src: string) => Tokens.Paragraph | undefined;

method reflink

reflink: (
    src: string,
    links: Links
) => Tokens.Link | Tokens.Image | Tokens.Text | undefined;

method space

space: (src: string) => Tokens.Space | undefined;

method table

table: (src: string) => Tokens.Table | undefined;

method tag

tag: (src: string) => Tokens.Tag | undefined;

method text

text: (src: string) => Tokens.Text | undefined;

method url

url: (src: string) => Tokens.Link | undefined;

Interfaces

interface MarkedExtension

interface MarkedExtension<ParserOutput = string, RendererOutput = string> {}

property async

async?: boolean;

True will tell marked to await any walkTokens functions before parsing the tokens and returning an HTML string.

property breaks

breaks?: boolean;

Enable GFM line breaks. This option requires the gfm option to be true.

property extensions

extensions?:
    | TokenizerAndRendererExtension<ParserOutput, RendererOutput>[]
    | null;

Add tokenizers and renderers to marked

property gfm

gfm?: boolean;

Enable GitHub flavored markdown.

property hooks

hooks?: HooksObject<ParserOutput, RendererOutput> | null;

Hooks are methods that hook into some part of marked. 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. emStrongMask is called to mask contents that should not be interpreted as em/strong delimiters. provideLexer is called to provide a function to tokenize markdown. provideParser is called to provide a function to parse tokens.

property pedantic

pedantic?: boolean;

Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.

property renderer

renderer?: RendererObject<ParserOutput, RendererOutput> | null;

Type: object Default: new Renderer()
An object containing functions to render tokens to HTML.

property silent

silent?: boolean;

Shows an HTML error message when rendering fails.

property tokenizer

tokenizer?: TokenizerObject | null;

The tokenizer defines how to turn markdown text into tokens.

property walkTokens

walkTokens?: ((token: Token) => void | Promise<void>) | 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.

interface MarkedOptions

interface MarkedOptions<ParserOutput = string, RendererOutput = string>
    extends Omit<
        MarkedExtension<ParserOutput, RendererOutput>,
        'hooks' | 'renderer' | 'tokenizer' | 'extensions' | 'walkTokens'
    > {}

property extensions

extensions?: null | {
    renderers: {
        [name: string]: RendererExtensionFunction<ParserOutput, RendererOutput>;
    };
    childTokens: {
        [name: string]: string[];
    };
    inline?: TokenizerExtensionFunction[];
    block?: TokenizerExtensionFunction[];
    startInline?: TokenizerStartFunction[];
    startBlock?: TokenizerStartFunction[];
};

Custom extensions

property hooks

hooks?: _Hooks<ParserOutput, RendererOutput> | null;

Hooks are methods that hook into some part of marked.

property renderer

renderer?: _Renderer<ParserOutput, RendererOutput> | null;

Type: object Default: new Renderer()
An object containing functions to render tokens to HTML.

property tokenizer

tokenizer?: _Tokenizer<ParserOutput, RendererOutput> | null;

The tokenizer defines how to turn markdown text into tokens.

property walkTokens

walkTokens?:
    | null
    | ((token: Token) => void | Promise<void> | (void | Promise<void>)[]);

walkTokens function returns array of values for Promise.all

interface RendererExtension

interface RendererExtension<ParserOutput = string, RendererOutput = string> {}

property name

name: string;

property renderer

renderer: RendererExtensionFunction<ParserOutput, RendererOutput>;

interface RendererThis

interface RendererThis<ParserOutput = string, RendererOutput = string> {}

property parser

parser: _Parser<ParserOutput, RendererOutput>;

interface Rules

interface Rules {}

property block

block: Record<BlockKeys, RegExp>;

property inline

inline: Record<InlineKeys, RegExp>;

property other

other: typeof other;

interface TokenizerExtension

interface TokenizerExtension {}

property childTokens

childTokens?: string[];

property level

level: 'block' | 'inline';

property name

name: string;

property start

start?: TokenizerStartFunction;

property tokenizer

tokenizer: TokenizerExtensionFunction;

interface TokenizerThis

interface TokenizerThis {}

property lexer

lexer: _Lexer;

Type Aliases

type BlockKeys

type BlockKeys = keyof typeof blockNormal;

type HooksApi

type HooksApi<ParserOutput = string, RendererOutput = string> = Omit<
    _Hooks<ParserOutput, RendererOutput>,
    'constructor' | 'options' | 'block'
>;

type HooksObject

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]>>;
};

type InlineKeys

type InlineKeys = keyof typeof inlineNormal;

type Links

type Links = Record<string, Pick<Tokens.Link | Tokens.Image, 'href' | 'title'>>;

type MarkedToken

type MarkedToken =
    | Tokens.Blockquote
    | Tokens.Br
    | Tokens.Code
    | Tokens.Codespan
    | Tokens.Def
    | Tokens.Del
    | Tokens.Em
    | Tokens.Escape
    | Tokens.Heading
    | Tokens.Hr
    | Tokens.HTML
    | Tokens.Image
    | Tokens.Link
    | Tokens.List
    | Tokens.ListItem
    | Tokens.Paragraph
    | Tokens.Space
    | Tokens.Strong
    | Tokens.Table
    | Tokens.Tag
    | Tokens.Text;

type MaybePromise

type MaybePromise = void | Promise<void>;

type RendererApi

type RendererApi<ParserOutput = string, RendererOutput = string> = Omit<
    _Renderer<ParserOutput, RendererOutput>,
    'constructor' | 'options' | 'parser'
>;

type RendererExtensionFunction

type RendererExtensionFunction<ParserOutput = string, RendererOutput = string> = (
    this: RendererThis<ParserOutput, RendererOutput>,
    token: Tokens.Generic
) => RendererOutput | false | undefined;

type RendererObject

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;
};

type Token

type Token = MarkedToken | Tokens.Generic;

type TokenizerAndRendererExtension

type TokenizerAndRendererExtension<ParserOutput = string, RendererOutput = string> =
    | TokenizerExtension
    | RendererExtension<ParserOutput, RendererOutput>
    | (TokenizerExtension & RendererExtension<ParserOutput, RendererOutput>);

type TokenizerApi

type TokenizerApi<ParserOutput = string, RendererOutput = string> = Omit<
    _Tokenizer<ParserOutput, RendererOutput>,
    'constructor' | 'options' | 'rules' | 'lexer'
>;

type TokenizerExtensionFunction

type TokenizerExtensionFunction = (
    this: TokenizerThis,
    src: string,
    tokens: Token[] | TokensList
) => Tokens.Generic | undefined;

type TokenizerObject

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;
};

type TokenizerStartFunction

type TokenizerStartFunction = (this: TokenizerThis, src: string) => number | void;

type TokensList

type TokensList = Token[] & {
    links: Links;
};

Namespaces

namespace marked

namespace marked {}

variable defaults

var defaults: MarkedOptions<any, any>;

variable getDefaults

var getDefaults: <ParserOutput = string, RendererOutput = string>() => MarkedOptions<
    ParserOutput,
    RendererOutput
>;

variable Hooks

var Hooks: typeof _Hooks;

variable lexer

var lexer: <ParserOutput = string, RendererOutput = string>(
    src: string,
    options?: MarkedOptions<ParserOutput, RendererOutput>
) => TokensList;

variable Lexer

var Lexer: typeof _Lexer;

variable parse

var parse: typeof marked;

variable parseInline

var parseInline: {
    (
        src: string,
        options: MarkedOptions<string, string> & { async: true }
    ): Promise<string>;
    (src: string, options: MarkedOptions<string, string> & { async: false }): string;
    (src: string, options?: MarkedOptions<string, string> | null | undefined):
        | string
        | Promise<string>;
};

variable parser

var parser: <ParserOutput = string, RendererOutput = string>(
    tokens: Token[],
    options?: MarkedOptions<ParserOutput, RendererOutput>
) => ParserOutput;

variable Parser

var Parser: typeof _Parser;

variable Renderer

var Renderer: typeof _Renderer;

variable TextRenderer

var TextRenderer: typeof _TextRenderer;

variable Tokenizer

var Tokenizer: typeof _Tokenizer;

function options

options: (options: MarkedOptions) => typeof marked;

function setOptions

setOptions: (options: MarkedOptions) => typeof marked;

function use

use: (...args: MarkedExtension[]) => typeof marked;

function walkTokens

walkTokens: (
    tokens: Token[] | TokensList,
    callback: (token: Token) => MaybePromise | MaybePromise[]
) => MaybePromise[];

namespace Tokens

namespace Tokens {}

interface Blockquote

interface Blockquote {}

property raw

raw: string;

property text

text: string;

property tokens

tokens: Token[];

property type

type: 'blockquote';

interface Br

interface Br {}

property raw

raw: string;

property type

type: 'br';

interface Checkbox

interface Checkbox {}

property checked

checked: boolean;

interface Code

interface Code {}

property codeBlockStyle

codeBlockStyle?: 'indented';

property escaped

escaped?: boolean;

property lang

lang?: string;

property raw

raw: string;

property text

text: string;

property type

type: 'code';

interface Codespan

interface Codespan {}

property raw

raw: string;

property text

text: string;

property type

type: 'codespan';

interface Def

interface Def {}

property href

href: string;

property raw

raw: string;

property tag

tag: string;

property title

title: string;

property type

type: 'def';

interface Del

interface Del {}

property raw

raw: string;

property text

text: string;

property tokens

tokens: Token[];

property type

type: 'del';

interface Em

interface Em {}

property raw

raw: string;

property text

text: string;

property tokens

tokens: Token[];

property type

type: 'em';

interface Escape

interface Escape {}

property raw

raw: string;

property text

text: string;

property type

type: 'escape';

interface Generic

interface Generic {}

property raw

raw: string;

property tokens

tokens?: Token[];

property type

type: string;

index signature

[index: string]: any;

interface Heading

interface Heading {}

property depth

depth: number;

property raw

raw: string;

property text

text: string;

property tokens

tokens: Token[];

property type

type: 'heading';

interface Hr

interface Hr {}

property raw

raw: string;

property type

type: 'hr';

interface HTML

interface HTML {}

property block

block: boolean;

property pre

pre: boolean;

property raw

raw: string;

property text

text: string;

property type

type: 'html';

interface Image

interface Image {}

property href

href: string;

property raw

raw: string;

property text

text: string;

property title

title: string | null;

property tokens

tokens: Token[];

property type

type: 'image';

interface Link

interface Link {}

property href

href: string;

property raw

raw: string;

property text

text: string;

property title

title?: string | null;

property tokens

tokens: Token[];

property type

type: 'link';

interface List

interface List {}

property items

items: ListItem[];

property loose

loose: boolean;

property ordered

ordered: boolean;

property raw

raw: string;

property start

start: number | '';

property type

type: 'list';

interface ListItem

interface ListItem {}

property checked

checked?: boolean;

property loose

loose: boolean;

property raw

raw: string;

property task

task: boolean;

property text

text: string;

property tokens

tokens: Token[];

property type

type: 'list_item';

interface Paragraph

interface Paragraph {}

property pre

pre?: boolean;

property raw

raw: string;

property text

text: string;

property tokens

tokens: Token[];

property type

type: 'paragraph';

interface Space

interface Space {}

property raw

raw: string;

property type

type: 'space';

interface Strong

interface Strong {}

property raw

raw: string;

property text

text: string;

property tokens

tokens: Token[];

property type

type: 'strong';

interface Table

interface Table {}

property align

align: Array<'center' | 'left' | 'right' | null>;

header: TableCell[];

property raw

raw: string;

property rows

rows: TableCell[][];

property type

type: 'table';

interface TableCell

interface TableCell {}

property align

align: 'center' | 'left' | 'right' | null;

header: boolean;

property text

text: string;

property tokens

tokens: Token[];

interface TableRow

interface TableRow<P = string> {}

property text

text: P;

interface Tag

interface Tag {}

property block

block: boolean;

property inLink

inLink: boolean;

property inRawBlock

inRawBlock: boolean;

property raw

raw: string;

property text

text: string;

property type

type: 'html';

interface Text

interface Text {}

property escaped

escaped?: boolean;

property raw

raw: string;

property text

text: string;

property tokens

tokens?: Token[];

property type

type: 'text';

Package Files (1)

lib/marked.d.ts

Dependencies (0)

No dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/marked.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/marked)

HTML

<a href="https://www.jsdocs.io/package/marked"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 13 days ago.
Package analyzed in 6948 ms.
Missing or incorrect documentation? Open an issue for this package.

marked

Install

Overview

Index

Variables

Functions

Classes

Interfaces

Type Aliases

Namespaces

Variables

variable blockNormal

variable defaults

variable inlineNormal

variable lexer

variable other

variable parse

variable parseInline

variable parser

Functions

function getDefaults

function marked

Parameter src

Parameter options

Parameter src

Parameter options

function options

function setOptions

function use

function walkTokens

Classes

class Hooks

constructor

property block

property options

property passThroughHooks

property passThroughHooksRespectAsync

method emStrongMask

method postprocess

method preprocess

method processAllTokens

method provideLexer

method provideParser

class Lexer

constructor

property options

property rules

property state

property tokens

method blockTokens

method inline

method inlineTokens

method lex

method lexInline

class Marked

constructor

property defaults

property Hooks

property Lexer

property options

property parse

property parseInline

property Parser

property Renderer

property TextRenderer

property Tokenizer

method lexer

method parser

method setOptions

method use

method walkTokens

class Parser

constructor

property options

property renderer

property textRenderer

method parse

method parseInline

class Renderer

constructor