Welshman

Appearance

Welshman Docs / @welshman/content

@welshman/content ​

Enumerations ​

ParsedType ​

Defined in: parser.ts:39

Enumeration Members ​

Address ​

Address: "address"

Defined in: parser.ts:40

Cashu ​

Cashu: "cashu"

Defined in: parser.ts:41

Code ​

Code: "code"

Defined in: parser.ts:42

Command ​

Command: "command"

Defined in: parser.ts:43

Ellipsis ​

Ellipsis: "ellipsis"

Defined in: parser.ts:44

Email ​

Email: "email"

Defined in: parser.ts:45

Emoji ​

Emoji: "emoji"

Defined in: parser.ts:46

Event ​

Event: "event"

Defined in: parser.ts:47

Invoice ​

Invoice: "invoice"

Defined in: parser.ts:48

Link: "link"

Defined in: parser.ts:49

LinkGrid ​

LinkGrid: "link-grid"

Defined in: parser.ts:50

Newline ​

Newline: "newline"

Defined in: parser.ts:51

Profile ​

Profile: "profile"

Defined in: parser.ts:52

Room ​

Room: "room"

Defined in: parser.ts:53

Text ​

Text: "text"

Defined in: parser.ts:54

Topic ​

Topic: "topic"

Defined in: parser.ts:55

Classes ​

Type Aliases ​

AddressPointer ​

AddressPointer = object

Defined in: parser.ts:12

Properties ​

identifier ​

identifier: string

Defined in: parser.ts:13

kind ​

kind: number

Defined in: parser.ts:15

pubkey ​

pubkey: string

Defined in: parser.ts:14

relays? ​

optional relays: string[]

Defined in: parser.ts:16

EventPointer ​

EventPointer = object

Defined in: parser.ts:19

Properties ​

author? ​

optional author: string

Defined in: parser.ts:22

id ​

id: string

Defined in: parser.ts:20

kind? ​

optional kind: number

Defined in: parser.ts:23

relays? ​

optional relays: string[]

Defined in: parser.ts:21

ParseContext ​

ParseContext = object

Defined in: parser.ts:33

Properties ​

content ​

content: string

Defined in: parser.ts:35

results ​

results: Parsed[]

Defined in: parser.ts:34

tags ​

tags: string[][]

Defined in: parser.ts:36

Parsed ​

Parsed = ParsedAddress | ParsedCashu | ParsedCode | ParsedCommand | ParsedEllipsis | ParsedEmail | ParsedEmoji | ParsedEvent | ParsedInvoice | ParsedLink | ParsedLinkGrid | ParsedNewline | ParsedProfile | ParsedRoom | ParsedText | ParsedTopic

Defined in: parser.ts:166

ParsedAddress ​

ParsedAddress = ParsedBase & object

Defined in: parser.ts:151

Type declaration ​

type ​

type: Address

value ​

value: AddressPointer

ParsedBase ​

ParsedBase = object

Defined in: parser.ts:58

Properties ​

raw ​

raw: string

Defined in: parser.ts:59

ParsedCashu ​

ParsedCashu = ParsedBase & object

Defined in: parser.ts:62

Type declaration ​

type ​

type: Cashu

value ​

value: string

ParsedCode ​

ParsedCode = ParsedBase & object

Defined in: parser.ts:67

Type declaration ​

type ​

type: Code

value ​

value: string

ParsedCommand ​

ParsedCommand = ParsedBase & object

Defined in: parser.ts:77

Type declaration ​

type ​

type: Command

value ​

value: ParsedCommandValue

ParsedCommandValue ​

ParsedCommandValue = object

Defined in: parser.ts:72

Properties ​

command ​

command: string

Defined in: parser.ts:73

pubkey? ​

optional pubkey: string

Defined in: parser.ts:74

ParsedEllipsis ​

ParsedEllipsis = ParsedBase & object

Defined in: parser.ts:82

Type declaration ​

type ​

type: Ellipsis

value ​

value: string

ParsedEmail ​

ParsedEmail = ParsedBase & object

Defined in: parser.ts:87

Type declaration ​

type ​

type: Email

value ​

value: string

ParsedEmoji ​

ParsedEmoji = ParsedBase & object

Defined in: parser.ts:97

Type declaration ​

type ​

type: Emoji

value ​

value: ParsedEmojiValue

ParsedEmojiValue ​

ParsedEmojiValue = object

Defined in: parser.ts:92

Properties ​

name ​

name: string

Defined in: parser.ts:93

url? ​

optional url: string

Defined in: parser.ts:94

ParsedEvent ​

ParsedEvent = ParsedBase & object

Defined in: parser.ts:141

Type declaration ​

type ​

type: Event

value ​

value: EventPointer

ParsedInvoice ​

ParsedInvoice = ParsedBase & object

Defined in: parser.ts:102

Type declaration ​

type ​

type: Invoice

value ​

value: string

ParsedLink = ParsedBase & object

Defined in: parser.ts:116

Type declaration ​

type ​

type: Link

value ​

value: ParsedLinkValue

ParsedLinkGrid ​

ParsedLinkGrid = ParsedBase & object

Defined in: parser.ts:121

Type declaration ​

type ​

type: LinkGrid

value ​

value: ParsedLinkGridValue

ParsedLinkGridValue ​

ParsedLinkGridValue = object

Defined in: parser.ts:112

Properties ​

links: ParsedLinkValue[]

Defined in: parser.ts:113

ParsedLinkValue ​

ParsedLinkValue = object

Defined in: parser.ts:107

Properties ​

meta ​

meta: Record<string, string>

Defined in: parser.ts:109

url ​

url: URL

Defined in: parser.ts:108

ParsedNewline ​

ParsedNewline = ParsedBase & object

Defined in: parser.ts:126

Type declaration ​

type ​

type: Newline

value ​

value: string

ParsedProfile ​

ParsedProfile = ParsedBase & object

Defined in: parser.ts:146

Type declaration ​

type ​

type: Profile

value ​

value: ProfilePointer

ParsedRoom ​

ParsedRoom = ParsedBase & object

Defined in: parser.ts:161

Type declaration ​

type ​

type: Room

value ​

value: ParsedRoomValue

ParsedRoomValue ​

ParsedRoomValue = object

Defined in: parser.ts:156

Properties ​

room ​

room: string

Defined in: parser.ts:158

url ​

url: string

Defined in: parser.ts:157

ParsedText ​

ParsedText = ParsedBase & object

Defined in: parser.ts:131

Type declaration ​

type ​

type: Text

value ​

value: string

ParsedTopic ​

ParsedTopic = ParsedBase & object

Defined in: parser.ts:136

Type declaration ​

type ​

type: Topic

value ​

value: string

ProfilePointer ​

ProfilePointer = object

Defined in: parser.ts:26

Properties ​

pubkey ​

pubkey: string

Defined in: parser.ts:27

relays? ​

optional relays: string[]

Defined in: parser.ts:28

RenderOptions ​

RenderOptions = object

Defined in: render.ts:49

Properties ​

createElement()? ​

optional createElement: (tag) => any

Defined in: render.ts:55

Parameters ​
tag ​

string

Returns ​

any

entityBase ​

entityBase: string

Defined in: render.ts:51

escapeText() ​

escapeText: (value) => string

Defined in: render.ts:52

Parameters ​
value ​

string

Returns ​

string

newline ​

newline: string

Defined in: render.ts:50

renderEntity() ​

renderEntity: (entity) => string

Defined in: render.ts:54

Parameters ​
entity ​

string

Returns ​

string

renderLink: (href, display) => string

Defined in: render.ts:53

Parameters ​
href ​

string

display ​

string

Returns ​

string

Variables ​

htmlRenderOptions ​

const htmlRenderOptions: object

Defined in: render.ts:66

Type declaration ​

createElement() ​

createElement: (tag) => any

Parameters ​
tag ​

string

Returns ​

any

entityBase ​

entityBase: string = "https://njump.me/"

newline ​

newline: string = "\n"

renderEntity() ​

renderEntity: (entity) => string

Parameters ​
entity ​

string

Returns ​

string

escapeText() ​

escapeText(value): any

Parameters ​
value ​

string

Returns ​

any

renderLink(href, display): any

Parameters ​
href ​

string

display ​

string

Returns ​

any

parsers ​

const parsers: ((text, context) => void | ParsedAddress | (text, context) => void | ParsedCashu | (text, context) => void | ParsedCode | (text, context) => void | ParsedCommand | (text, context) => void | ParsedEmoji | (text, context) => void | ParsedEmail | (text, context) => void | ParsedInvoice | (text, context) => void | ParsedLink | (text, context) => void | ParsedNewline | (text, context) => void | ParsedRoom | (text, context) => void | ParsedTopic | (text, context) => void | ParsedEvent | ParsedProfile)[]

Defined in: parser.ts:468

textRenderOptions ​

const textRenderOptions: object

Defined in: render.ts:58

Type declaration ​

entityBase ​

entityBase: string = ""

escapeText() ​

escapeText: (value) => string

Parameters ​
value ​

string

Returns ​

string

newline ​

newline: string = "\n"

renderEntity() ​

renderEntity: (entity) => string

Parameters ​
entity ​

string

Returns ​

string

renderLink: (href, display) => string

Parameters ​
href ​

string

display ​

string

Returns ​

string

Functions ​

isAddress() ​

isAddress(parsed): parsed is ParsedAddress

Defined in: parser.ts:186

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedAddress

isCashu() ​

isCashu(parsed): parsed is ParsedCashu

Defined in: parser.ts:188

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedCashu

isCode() ​

isCode(parsed): parsed is ParsedCode

Defined in: parser.ts:189

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedCode

isCommand() ​

isCommand(parsed): parsed is ParsedCommand

Defined in: parser.ts:190

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedCommand

isEllipsis() ​

isEllipsis(parsed): parsed is ParsedEllipsis

Defined in: parser.ts:192

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedEllipsis

isEmail() ​

isEmail(parsed): parsed is ParsedEmail

Defined in: parser.ts:194

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedEmail

isEmoji() ​

isEmoji(parsed): parsed is ParsedEmoji

Defined in: parser.ts:195

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedEmoji

isEvent() ​

isEvent(parsed): parsed is ParsedEvent

Defined in: parser.ts:196

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedEvent

isImage() ​

isImage(parsed): parsed is ParsedLink

Defined in: parser.ts:200

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedLink

isInvoice() ​

isInvoice(parsed): parsed is ParsedInvoice

Defined in: parser.ts:197

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedInvoice

isLink(parsed): parsed is ParsedLink

Defined in: parser.ts:199

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedLink

isLinkGrid() ​

isLinkGrid(parsed): parsed is ParsedLinkGrid

Defined in: parser.ts:202

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedLinkGrid

isNewline() ​

isNewline(parsed): parsed is ParsedNewline

Defined in: parser.ts:204

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedNewline

isProfile() ​

isProfile(parsed): parsed is ParsedProfile

Defined in: parser.ts:206

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedProfile

isRoom() ​

isRoom(parsed): parsed is ParsedRoom

Defined in: parser.ts:208

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedRoom

isText() ​

isText(parsed): parsed is ParsedText

Defined in: parser.ts:209

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedText

isTopic() ​

isTopic(parsed): parsed is ParsedTopic

Defined in: parser.ts:210

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedTopic

makeHtmlRenderer() ​

makeHtmlRenderer(options): Renderer

Defined in: render.ts:92

Parameters ​

options ​

Partial<RenderOptions> = {}

Returns ​

Renderer

makeTextRenderer() ​

makeTextRenderer(options): Renderer

Defined in: render.ts:89

Parameters ​

options ​

Partial<RenderOptions> = {}

Returns ​

Renderer

parse() ​

parse(__namedParameters): Parsed[]

Defined in: parser.ts:498

Parameters ​

__namedParameters ​
content? ​

string = ""

tags? ​

string[][] = []

Returns ​

Parsed[]

parseAddress() ​

parseAddress(text, context): void | ParsedAddress

Defined in: parser.ts:214

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedAddress

parseCashu() ​

parseCashu(text, context): void | ParsedCashu

Defined in: parser.ts:228

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedCashu

parseCodeBlock() ​

parseCodeBlock(text, context): void | ParsedCode

Defined in: parser.ts:236

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedCode

parseCodeInline() ​

parseCodeInline(text, context): void | ParsedCode

Defined in: parser.ts:244

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedCode

parseCommand() ​

parseCommand(text, context): void | ParsedCommand

Defined in: parser.ts:273

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedCommand

parseEmail() ​

parseEmail(text, context): void | ParsedEmail

Defined in: parser.ts:321

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedEmail

parseEmoji() ​

parseEmoji(text, context): void | ParsedEmoji

Defined in: parser.ts:296

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedEmoji

parseEvent() ​

parseEvent(text, context): void | ParsedEvent

Defined in: parser.ts:306

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedEvent

parseInvoice() ​

parseInvoice(text, context): void | ParsedInvoice

Defined in: parser.ts:330

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedInvoice

parseLegacyMention() ​

parseLegacyMention(text, context): void | ParsedEvent | ParsedProfile

Defined in: parser.ts:448

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedEvent | ParsedProfile

parseLink(text, context): void | ParsedLink

Defined in: parser.ts:344

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedLink

parseNewline() ​

parseNewline(text, context): void | ParsedNewline

Defined in: parser.ts:398

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedNewline

parseNext() ​

parseNext(raw, context): void | Parsed

Defined in: parser.ts:486

Parameters ​

raw ​

string

context ​

ParseContext

Returns ​

void | Parsed

parseProfile() ​

parseProfile(text, context): void | ParsedProfile

Defined in: parser.ts:406

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedProfile

parseRoom() ​

parseRoom(text, context): void | ParsedRoom

Defined in: parser.ts:422

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedRoom

parseTopic() ​

parseTopic(text, context): void | ParsedTopic

Defined in: parser.ts:437

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedTopic

reduceLinks(content): Parsed[]

Defined in: parser.ts:595

Parameters ​

content ​

Parsed[]

Returns ​

Parsed[]

render() ​

render(parsed, renderer): Renderer

Defined in: render.ts:192

Parameters ​

parsed ​

Parsed | Parsed[]

renderer ​

Renderer

Returns ​

Renderer

renderAddress() ​

renderAddress(p, r): void

Defined in: render.ts:129

Parameters ​

p ​

ParsedAddress

r ​

Renderer

Returns ​

void

renderAsHtml() ​

renderAsHtml(parsed, options): Renderer

Defined in: render.ts:198

Parameters ​

parsed ​

Parsed | Parsed[]

options ​

Partial<RenderOptions> = {}

Returns ​

Renderer

renderAsText() ​

renderAsText(parsed, options): Renderer

Defined in: render.ts:195

Parameters ​

parsed ​

Parsed | Parsed[]

options ​

Partial<RenderOptions> = {}

Returns ​

Renderer

renderCashu() ​

renderCashu(p, r): void

Defined in: render.ts:97

Parameters ​

p ​

ParsedCashu

r ​

Renderer

Returns ​

void

renderCode() ​

renderCode(p, r): void

Defined in: render.ts:99

Parameters ​

p ​

ParsedCode

r ​

Renderer

Returns ​

void

renderCommand() ​

renderCommand(p, r): void

Defined in: render.ts:101

Parameters ​

p ​

ParsedCommand

r ​

Renderer

Returns ​

void

renderEllipsis() ​

renderEllipsis(p, r): void

Defined in: render.ts:103

Parameters ​

p ​

ParsedEllipsis

r ​

Renderer

Returns ​

void

renderEmail() ​

renderEmail(p, r): void

Defined in: render.ts:105

Parameters ​

p ​

ParsedEmail

r ​

Renderer

Returns ​

void

renderEmoji() ​

renderEmoji(p, r): void

Defined in: render.ts:107

Parameters ​

p ​

ParsedEmoji

r ​

Renderer

Returns ​

void

renderEvent() ​

renderEvent(p, r): void

Defined in: render.ts:124

Parameters ​

p ​

ParsedEvent

r ​

Renderer

Returns ​

void

renderInvoice() ​

renderInvoice(p, r): void

Defined in: render.ts:109

Parameters ​

p ​

ParsedInvoice

r ​

Renderer

Returns ​

void

renderLink(p, r): void

Defined in: render.ts:112

Parameters ​

p ​

ParsedLink

r ​

Renderer

Returns ​

void

renderMany() ​

renderMany(parsed, renderer): Renderer

Defined in: render.ts:184

Parameters ​

parsed ​

Parsed[]

renderer ​

Renderer

Returns ​

Renderer

renderNewline() ​

renderNewline(p, r): void

Defined in: render.ts:115

Parameters ​

p ​

ParsedNewline

r ​

Renderer

Returns ​

void

renderOne() ​

renderOne(parsed, renderer): Renderer

Defined in: render.ts:132

Parameters ​

parsed ​

Parsed

renderer ​

Renderer

Returns ​

Renderer

renderProfile() ​

renderProfile(p, r): void

Defined in: render.ts:126

Parameters ​

p ​

ParsedProfile

r ​

Renderer

Returns ​

void

renderRoom() ​

renderRoom(p, r): void

Defined in: render.ts:122

Parameters ​

p ​

ParsedRoom

r ​

Renderer

Returns ​

void

renderText() ​

renderText(p, r): void

Defined in: render.ts:118

Parameters ​

p ​

ParsedText

r ​

Renderer

Returns ​

void

renderTopic() ​

renderTopic(p, r): void

Defined in: render.ts:120

Parameters ​

p ​

ParsedTopic

r ​

Renderer

Returns ​

void

truncate() ​

truncate(content, __namedParameters): Parsed[]

Defined in: parser.ts:542

Parameters ​

content ​

Parsed[]

__namedParameters ​

TruncateOpts = {}

Returns ​

Parsed[]

urlIsMedia() ​

urlIsMedia(url): boolean

Defined in: parser.ts:7

Parameters ​

url ​

string

Returns ​

boolean