Module "parse"

Index

Enumerations

State

Interfaces

FSMCtx

Type aliases

ParseResult

Variables

Object literals

DEFAULT_TAGS

Type aliases

ParseResult

ParseResult: ResultBody<any[]>

Variables

Const BQUOTE

BQUOTE: ">" = ">"

Const CODE

CODE: "`" = "`"

Const CODEBLOCK

CODEBLOCK: "```" = "```"

Const CODEBLOCK_END

CODEBLOCK_END: "```" = "```"

Const EM

EM: "_" = "_"

Const HD

HD: "#" = "#"

Const HR

HR: "-" = "-"

Const IMG

IMG: "![" = "!["

Const LI

LI: "- " = "- "

Const LINK_HREF

LINK_HREF: "(" = "("

Const LINK_HREF_END

LINK_HREF_END: ")" = ")"

Const LINK_LABEL

LINK_LABEL: "[" = "["

Const LINK_LABEL_END

LINK_LABEL_END: "]" = "]"

Const NL

NL: "" = ""

Const STRIKE

STRIKE: "~~" = "~~"

Const STRONG

STRONG: "**" = "**"

Const TD

TD: "|" = "|"

Functions

Const collect

collect(id: State): (Anonymous function)

- Defined in parse.ts:124
Parameters
- id: State
Returns (Anonymous function)

Const collectAndRestart

collectAndRestart(tag: (xs: any[]) => any[]): (Anonymous function)

- Defined in parse.ts:132
Parameters
- tag: (xs: any[]) => any[]
  - - (xs: any[]): any[]
    - Parameters
      - xs: any[]
      Returns any[]
Returns (Anonymous function)

Const collectBlockQuote

collectBlockQuote(ctx: FSMCtx): ParseResult

- Defined in parse.ts:136
Parameters
- ctx: FSMCtx
Returns ParseResult

Const collectChildren

collectChildren(ctx: FSMCtx): any[]

- Defined in parse.ts:120
Parameters
- ctx: FSMCtx
Returns any[]

Const collectCodeBlock

collectCodeBlock(tag: Fn2<string, string, any[]>): (Anonymous function)

- Defined in parse.ts:140
Parameters
- tag: Fn2<string, string, any[]>
Returns (Anonymous function)

Const collectHeading

collectHeading(tag: Fn2<number, any[], any[]>): (Anonymous function)

- Defined in parse.ts:128
Parameters
- tag: Fn2<number, any[], any[]>
Returns (Anonymous function)

Const collectInline

collectInline(fn: Fn<string, any[]>): (Anonymous function)

- Defined in parse.ts:175
Parameters
- fn: Fn<string, any[]>
Returns (Anonymous function)

Const collectLi

collectLi(ctx: FSMCtx, tag: Fn<any[], any[]>): number

- Defined in parse.ts:145
Parameters
- ctx: FSMCtx
- tag: Fn<any[], any[]>
Returns number

Const collectList

collectList(type: string, list: Fn2<string, any[], any[]>, item: Fn<any[], any[]>): (Anonymous function)

- Defined in parse.ts:148
Parameters
- type: string
- list: Fn2<string, any[], any[]>
- item: Fn<any[], any[]>
Returns (Anonymous function)

Const collectTD

collectTD(tag: Fn2<number, any[], any[]>): (Anonymous function)

- Defined in parse.ts:156
Parameters
- tag: Fn2<number, any[], any[]>
Returns (Anonymous function)

Const collectTR

collectTR(tag: Fn2<number, any[], any[]>): (Anonymous function)

- Defined in parse.ts:162
Parameters
- tag: Fn2<number, any[], any[]>
Returns (Anonymous function)

Const collectTable

collectTable(tag: Fn<any[], any[]>): (Anonymous function)

- Defined in parse.ts:169
Parameters
- tag: Fn<any[], any[]>
Returns (Anonymous function)

Const heading

heading(ctx: FSMCtx, body: string[]): ParseResult

- Defined in parse.ts:178
Parameters
- ctx: FSMCtx
- body: string[]
Returns ParseResult

Const matchInline

matchInline(id: State): Matcher<string, FSMCtx, any[]>[]

- Defined in parse.ts:182
Parameters
- id: State
Returns Matcher<string, FSMCtx, any[]>[]

Const matchLink

matchLink(result: Fn2<string, string, any[]>): Matcher<string, FSMCtx, any>

- Defined in parse.ts:191
Parameters
- result: Fn2<string, string, any[]>
Returns Matcher<string, FSMCtx, any>

Const matchPara

matchPara(id: State, next: State): Matcher<string, FSMCtx, any>

- Defined in parse.ts:207
Parameters
- id: State
- next: State
Returns Matcher<string, FSMCtx, any>

Const newList

newList(ctx: FSMCtx): ParseResult

- Defined in parse.ts:230
Parameters
- ctx: FSMCtx
Returns ParseResult

Const newPara

newPara(ctx: FSMCtx, buf: string[]): ParseResult

- Defined in parse.ts:216
Parameters
- ctx: FSMCtx
- buf: string[]
Returns ParseResult

Const newParaCode

newParaCode(ctx: FSMCtx, x: string[]): ParseResult

- Defined in parse.ts:224
Parameters
- ctx: FSMCtx
- x: string[]
Returns ParseResult

Const newParaInline

newParaInline(next: State): (Anonymous function)

- Defined in parse.ts:220
Parameters
- next: State
Returns (Anonymous function)

Const newTable

newTable(ctx: FSMCtx): ResultBody<any[]>

- Defined in parse.ts:234
Parameters
- ctx: FSMCtx
Returns ResultBody<any[]>

Const parse

parse(_tags?: Partial<TagFactories>): Transducer<string, any[]>

- Defined in parse.ts:245
Main parser / transducer. Defines state map with the various Markdown syntax matchers and state transition handlers. The returned parser itself is only used in index.ts.
Parameters
- Optional _tags: Partial<TagFactories>
Returns Transducer<string, any[]>

Const pop

pop(result: Fn2<FSMCtx, string, any>): (Anonymous function)

- Defined in parse.ts:109
Parameters
- result: Fn2<FSMCtx, string, any>
Returns (Anonymous function)

Const push

push(id: State, next: State): (Anonymous function)

- Defined in parse.ts:104
Parameters
- id: State
- next: State
Returns (Anonymous function)

Const transition

transition(ctx: FSMCtx, id: State): ParseResult

- Defined in parse.ts:100
Parameters
- ctx: FSMCtx
- id: State
Returns ParseResult

Object literals

Const DEFAULT_TAGS

DEFAULT_TAGS: object

Default hiccup element factories

blockquote

blockquote(xs: any[]): any[]

- Defined in parse.ts:62
Parameters
- xs: any[]
Returns any[]

code

code(body: string): string[]

- Defined in parse.ts:63
Parameters
- body: string
Returns string[]

codeblock

codeblock(lang: string, body: string): (string | { lang: string })[]

- Defined in parse.ts:64
Parameters
- lang: string
- body: string
Returns (string | { lang: string })[]

em

em(body: string): string[]

- Defined in parse.ts:65
Parameters
- body: string
Returns string[]

heading

heading(level: number, xs: any[]): any[]

- Defined in parse.ts:66
Parameters
- level: number
- xs: any[]
Returns any[]

hr

hr(): string[]

- Defined in parse.ts:67
Returns string[]

img

img(src: string, alt: string): (string | { alt: string; src: string })[]

- Defined in parse.ts:68
Parameters
- src: string
- alt: string
Returns (string | { alt: string; src: string })[]

li

li(xs: any[]): any[]

- Defined in parse.ts:69
Parameters
- xs: any[]
Returns any[]

link

link(href: string, body: string): (string | { href: string })[]

- Defined in parse.ts:70
Parameters
- href: string
- body: string
Returns (string | { href: string })[]

list

list(type: string, xs: any[]): any[]

- Defined in parse.ts:71
Parameters
- type: string
- xs: any[]
Returns any[]

paragraph

paragraph(xs: any[]): any[]

- Defined in parse.ts:72
Parameters
- xs: any[]
Returns any[]

strike

strike(body: string): string[]

- Defined in parse.ts:74
Parameters
- body: string
Returns string[]

strong

strong(body: string): string[]

- Defined in parse.ts:73
Parameters
- body: string
Returns string[]

table

table(rows: any[]): (string | any[])[]

- Defined in parse.ts:75
Parameters
- rows: any[]
Returns (string | any[])[]

td

td(_: number, xs: any[]): any[]

- Defined in parse.ts:76
Parameters
- _: number
- xs: any[]
Returns any[]

tr

tr(_: number, xs: any[]): any[]

- Defined in parse.ts:77
Parameters
- _: number
- xs: any[]
Returns any[]

Generated using TypeDoc