Module @welshman/content

@welshman/content version

Utilities for parsing and rendering note content. Customizable via RenderOptions.

import {parse, render} from '@welshman/content'

const content = "Hello<br>from https://coracle.tools! <script>alert('evil')</script>"
const parsed = parse({content, tags: []})
// [
// { type: 'text', value: 'Hello<br>from ', raw: 'Hello<br>from ' },
// {
// type: 'link',
// value: { url: URL, isMedia: false },
// raw: 'https://coracle.tools'
// },
// {
// type: 'text',
// value: "! <script>alert('evil')</script>",
// raw: "! <script>alert('evil')</script>"
// }
// ]

const result = renderAsText(parsed)
// => Hello&lt;br&gt;from https://coracle.tools/! &lt;script&gt;alert('evil')&lt;/script&gt;

const result = renderAsHtml(parsed)
// => Hello&lt;br&gt;from <a href="https://coracle.tools/" target="_blank">coracle.tools/</a>! &lt;script&gt;alert('evil')&lt;/script&gt;

Enumerations

ParsedType

Classes

Renderer

Type Aliases

ParseContext
Parsed
ParsedAddress
ParsedCashu
ParsedCode
ParsedEllipsis
ParsedEvent
ParsedInvoice
ParsedLink
ParsedLinkValue
ParsedNewline
ParsedProfile
ParsedText
ParsedTopic
RenderOptions

Variables

htmlRenderOptions
parsers
textRenderOptions

Functions

isAddress
isCashu
isCode
isEllipsis
isEvent
isInvoice
isLink
isNewline
isProfile
isText
isTopic
makeHtmlRenderer
makeTextRenderer
parse
parseAddress
parseCashu
parseCodeBlock
parseCodeInline
parseEvent
parseInvoice
parseLegacyMention
parseLink
parseNewline
parseNext
parseProfile
parseTopic
render
renderAddress
renderAsHtml
renderAsText
renderCashu
renderCode
renderEllipsis
renderEvent
renderInvoice
renderLink
renderMany
renderNewline
renderOne
renderProfile
renderText
renderTopic
truncate
urlIsMedia