Module

Marked.Bindings

Package: purescript-marked
Repository: thought2/purescript-marked

Low level bindings to marked.js Describes the JS API as it is in terms of PureScript types. There is no performance overhead compared to the JS API. Statically checked against TS types by ts-bridge.

#Align Source

type Align = (Lit "center" String) |+| (Lit "left" String) |+| (Lit "right" String) |+| Null

#Blockquote Source

type Blockquote = { raw :: String, text :: String, tokens :: Array Token }

#Br Source

type Br = { raw :: String }

#Code Source

type Code = TsRecord (codeBlockStyle :: Opt ~ (UndefinedOr (Lit "indented" String)), lang :: Opt ~ (UndefinedOr String), raw :: () ~ String, text :: () ~ String)

#Codespan Source

type Codespan = { raw :: String, text :: String }

#Def Source

type Def = { href :: String, raw :: String, tag :: String, title :: String }

#Del Source

type Del = { raw :: String, text :: String, tokens :: Array Token }

#Em Source

type Em = { raw :: String, text :: String, tokens :: Array Token }

#Escape Source

type Escape = { raw :: String, text :: String }

#Heading Source

type Heading = { depth :: Number, raw :: String, text :: String, tokens :: Array Token }

#Hr Source

type Hr = { raw :: String }

#Html Source

type Html = { block :: Lit True Boolean, pre :: Boolean, raw :: String, text :: String }

#Image Source

type Image = { href :: String, raw :: String, text :: String, title :: Nullable String }

#Link Source

type Link = { href :: String, raw :: String, text :: String, title :: Nullable String, tokens :: Array Token }

#LinkRef Source

type LinkRef = { href :: Nullable String, title :: Nullable String }

#Links Source

type Links = { links :: Object LinkRef }

#List Source

type List = { items :: Array ListItem, loose :: Boolean, ordered :: Boolean, raw :: String, start :: Number |+| (Lit "" String) }

#ListItem Source

type ListItem = TsRecord (checked :: (Opt) ~ (UndefinedOr Boolean), loose :: () ~ Boolean, raw :: () ~ String, task :: () ~ Boolean, text :: () ~ String, tokens :: () ~ (Array Token))

#Paragraph Source

type Paragraph = TsRecord (pre :: (Opt) ~ (UndefinedOr Boolean), raw :: () ~ String, text :: () ~ String, tokens :: () ~ (Array Token))

#Space Source

type Space = { raw :: String }

#Strong Source

type Strong = { raw :: String, text :: String, tokens :: Array Token }

#Table Source

type Table = { align :: Array Align, header :: Array TableCell, raw :: String, rows :: Array (Array TableCell) }

#TableCell Source

type TableCell = { text :: String, tokens :: Array Token }

#Tag Source

type Tag = { block :: Lit False Boolean, inLink :: Boolean, inRawBlock :: Boolean, raw :: String, text :: String }

#Text Source

type Text = TsRecord (raw :: () ~ String, text :: () ~ String, tokens :: (Opt) ~ (UndefinedOr (Array Token)))

#Token Source

newtype Token

Constructors

Token (VariantEncodedFlat "type" (blockquote :: Blockquote, br :: Br, code :: Code, codespan :: Codespan, def :: Def, del :: Del, em :: Em, escape :: Escape, heading :: Heading, hr :: Hr, html :: RecordUnion (Tag |+| Html), image :: Image, link :: Link, list :: List, list_item :: ListItem, paragraph :: Paragraph, space :: Space, strong :: Strong, table :: Table, text :: RecordUnion (Tag |+| Text)))

Instances

Newtype Token _
TsBridge Token

#lexer Source

lexer :: String -> EitherV String ((Array Token) |&| Links)

#tsModules Source

tsModules :: Either AppError (Array TsModuleFile)

Modules: Marked; Marked.Bindings