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

Ellipsis ​

Ellipsis: "ellipsis"

Defined in: parser.ts:43

Email ​

Email: "email"

Defined in: parser.ts:44

Emoji ​

Emoji: "emoji"

Defined in: parser.ts:45

Event ​

Event: "event"

Defined in: parser.ts:46

Invoice ​

Invoice: "invoice"

Defined in: parser.ts:47

Link: "link"

Defined in: parser.ts:48

LinkGrid ​

LinkGrid: "link-grid"

Defined in: parser.ts:49

Newline ​

Newline: "newline"

Defined in: parser.ts:50

Profile ​

Profile: "profile"

Defined in: parser.ts:51

Text ​

Text: "text"

Defined in: parser.ts:52

Topic ​

Topic: "topic"

Defined in: parser.ts:53

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 | ParsedEllipsis | ParsedEmail | ParsedEmoji | ParsedEvent | ParsedInvoice | ParsedLink | ParsedLinkGrid | ParsedNewline | ParsedProfile | ParsedText | ParsedTopic

Defined in: parser.ts:144

ParsedAddress ​

ParsedAddress = ParsedBase & object

Defined in: parser.ts:139

Type declaration ​

type ​

type: Address

value ​

value: AddressPointer

ParsedBase ​

ParsedBase = object

Defined in: parser.ts:56

Properties ​

raw ​

raw: string

Defined in: parser.ts:57

ParsedCashu ​

ParsedCashu = ParsedBase & object

Defined in: parser.ts:60

Type declaration ​

type ​

type: Cashu

value ​

value: string

ParsedCode ​

ParsedCode = ParsedBase & object

Defined in: parser.ts:65

Type declaration ​

type ​

type: Code

value ​

value: string

ParsedEllipsis ​

ParsedEllipsis = ParsedBase & object

Defined in: parser.ts:70

Type declaration ​

type ​

type: Ellipsis

value ​

value: string

ParsedEmail ​

ParsedEmail = ParsedBase & object

Defined in: parser.ts:75

Type declaration ​

type ​

type: Email

value ​

value: string

ParsedEmoji ​

ParsedEmoji = ParsedBase & object

Defined in: parser.ts:85

Type declaration ​

type ​

type: Emoji

value ​

value: ParsedEmojiValue

ParsedEmojiValue ​

ParsedEmojiValue = object

Defined in: parser.ts:80

Properties ​

name ​

name: string

Defined in: parser.ts:81

url? ​

optional url: string

Defined in: parser.ts:82

ParsedEvent ​

ParsedEvent = ParsedBase & object

Defined in: parser.ts:129

Type declaration ​

type ​

type: Event

value ​

value: EventPointer

ParsedInvoice ​

ParsedInvoice = ParsedBase & object

Defined in: parser.ts:90

Type declaration ​

type ​

type: Invoice

value ​

value: string

ParsedLink = ParsedBase & object

Defined in: parser.ts:104

Type declaration ​

type ​

type: Link

value ​

value: ParsedLinkValue

ParsedLinkGrid ​

ParsedLinkGrid = ParsedBase & object

Defined in: parser.ts:109

Type declaration ​

type ​

type: LinkGrid

value ​

value: ParsedLinkGridValue

ParsedLinkGridValue ​

ParsedLinkGridValue = object

Defined in: parser.ts:100

Properties ​

links: ParsedLinkValue[]

Defined in: parser.ts:101

ParsedLinkValue ​

ParsedLinkValue = object

Defined in: parser.ts:95

Properties ​

meta ​

meta: Record<string, string>

Defined in: parser.ts:97

url ​

url: URL

Defined in: parser.ts:96

ParsedNewline ​

ParsedNewline = ParsedBase & object

Defined in: parser.ts:114

Type declaration ​

type ​

type: Newline

value ​

value: string

ParsedProfile ​

ParsedProfile = ParsedBase & object

Defined in: parser.ts:134

Type declaration ​

type ​

type: Profile

value ​

value: ProfilePointer

ParsedText ​

ParsedText = ParsedBase & object

Defined in: parser.ts:119

Type declaration ​

type ​

type: Text

value ​

value: string

ParsedTopic ​

ParsedTopic = ParsedBase & object

Defined in: parser.ts:124

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:51

Properties ​

createElement() ​

createElement: (tag) => any

Defined in: render.ts:56

Parameters ​
tag ​

string

Returns ​

any

entityBase ​

entityBase: string

Defined in: render.ts:53

newline ​

newline: string

Defined in: render.ts:52

renderEntity() ​

renderEntity: (entity) => string

Defined in: render.ts:55

Parameters ​
entity ​

string

Returns ​

string

renderLink: (href, display) => string

Defined in: render.ts:54

Parameters ​
href ​

string

display ​

string

Returns ​

string

Variables ​

htmlRenderOptions ​

const htmlRenderOptions: object

Defined in: render.ts:67

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

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 | ParsedEmoji | (text, context) => void | ParsedEmail | (text, context) => void | ParsedInvoice | (text, context) => void | ParsedLink | (text, context) => void | ParsedNewline | (text, context) => void | ParsedTopic | (text, context) => void | ParsedEvent | ParsedProfile)[]

Defined in: parser.ts:376

textRenderOptions ​

const textRenderOptions: object

Defined in: render.ts:59

Type declaration ​

createElement() ​

createElement: (tag) => any

Parameters ​
tag ​

string

Returns ​

any

entityBase ​

entityBase: 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:162

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedAddress

isCashu() ​

isCashu(parsed): parsed is ParsedCashu

Defined in: parser.ts:164

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedCashu

isCode() ​

isCode(parsed): parsed is ParsedCode

Defined in: parser.ts:165

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedCode

isEllipsis() ​

isEllipsis(parsed): parsed is ParsedEllipsis

Defined in: parser.ts:166

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedEllipsis

isEmail() ​

isEmail(parsed): parsed is ParsedEmail

Defined in: parser.ts:168

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedEmail

isEmoji() ​

isEmoji(parsed): parsed is ParsedEmoji

Defined in: parser.ts:169

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedEmoji

isEvent() ​

isEvent(parsed): parsed is ParsedEvent

Defined in: parser.ts:170

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedEvent

isImage() ​

isImage(parsed): parsed is ParsedLink

Defined in: parser.ts:174

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedLink

isInvoice() ​

isInvoice(parsed): parsed is ParsedInvoice

Defined in: parser.ts:171

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedInvoice

isLink(parsed): parsed is ParsedLink

Defined in: parser.ts:173

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedLink

isLinkGrid() ​

isLinkGrid(parsed): parsed is ParsedLinkGrid

Defined in: parser.ts:176

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedLinkGrid

isNewline() ​

isNewline(parsed): parsed is ParsedNewline

Defined in: parser.ts:178

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedNewline

isProfile() ​

isProfile(parsed): parsed is ParsedProfile

Defined in: parser.ts:180

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedProfile

isText() ​

isText(parsed): parsed is ParsedText

Defined in: parser.ts:182

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedText

isTopic() ​

isTopic(parsed): parsed is ParsedTopic

Defined in: parser.ts:183

Parameters ​

parsed ​

Parsed

Returns ​

parsed is ParsedTopic

makeHtmlRenderer() ​

makeHtmlRenderer(options): Renderer

Defined in: render.ts:86

Parameters ​

options ​

Partial<RenderOptions> = {}

Returns ​

Renderer

makeTextRenderer() ​

makeTextRenderer(options): Renderer

Defined in: render.ts:83

Parameters ​

options ​

Partial<RenderOptions> = {}

Returns ​

Renderer

parse() ​

parse(__namedParameters): Parsed[]

Defined in: parser.ts:404

Parameters ​

__namedParameters ​
content? ​

string = ""

tags? ​

string[][] = []

Returns ​

Parsed[]

parseAddress() ​

parseAddress(text, context): void | ParsedAddress

Defined in: parser.ts:187

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedAddress

parseCashu() ​

parseCashu(text, context): void | ParsedCashu

Defined in: parser.ts:201

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedCashu

parseCodeBlock() ​

parseCodeBlock(text, context): void | ParsedCode

Defined in: parser.ts:209

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedCode

parseCodeInline() ​

parseCodeInline(text, context): void | ParsedCode

Defined in: parser.ts:217

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedCode

parseEmail() ​

parseEmail(text, context): void | ParsedEmail

Defined in: parser.ts:250

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedEmail

parseEmoji() ​

parseEmoji(text, context): void | ParsedEmoji

Defined in: parser.ts:225

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedEmoji

parseEvent() ​

parseEvent(text, context): void | ParsedEvent

Defined in: parser.ts:235

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedEvent

parseInvoice() ​

parseInvoice(text, context): void | ParsedInvoice

Defined in: parser.ts:259

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedInvoice

parseLegacyMention() ​

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

Defined in: parser.ts:356

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedEvent | ParsedProfile

parseLink(text, context): void | ParsedLink

Defined in: parser.ts:267

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedLink

parseNewline() ​

parseNewline(text, context): void | ParsedNewline

Defined in: parser.ts:321

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedNewline

parseNext() ​

parseNext(raw, context): void | Parsed

Defined in: parser.ts:392

Parameters ​

raw ​

string

context ​

ParseContext

Returns ​

void | Parsed

parseProfile() ​

parseProfile(text, context): void | ParsedProfile

Defined in: parser.ts:329

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedProfile

parseTopic() ​

parseTopic(text, context): void | ParsedTopic

Defined in: parser.ts:345

Parameters ​

text ​

string

context ​

ParseContext

Returns ​

void | ParsedTopic

reduceLinks(content): Parsed[]

Defined in: parser.ts:495

Parameters ​

content ​

Parsed[]

Returns ​

Parsed[]

render() ​

render(parsed, renderer): Renderer

Defined in: render.ts:176

Parameters ​

parsed ​

Parsed | Parsed[]

renderer ​

Renderer

Returns ​

Renderer

renderAddress() ​

renderAddress(p, r): void

Defined in: render.ts:119

Parameters ​

p ​

ParsedAddress

r ​

Renderer

Returns ​

void

renderAsHtml() ​

renderAsHtml(parsed, options): Renderer

Defined in: render.ts:182

Parameters ​

parsed ​

Parsed | Parsed[]

options ​

Partial<RenderOptions> = {}

Returns ​

Renderer

renderAsText() ​

renderAsText(parsed, options): Renderer

Defined in: render.ts:179

Parameters ​

parsed ​

Parsed | Parsed[]

options ​

Partial<RenderOptions> = {}

Returns ​

Renderer

renderCashu() ​

renderCashu(p, r): void

Defined in: render.ts:91

Parameters ​

p ​

ParsedCashu

r ​

Renderer

Returns ​

void

renderCode() ​

renderCode(p, r): void

Defined in: render.ts:93

Parameters ​

p ​

ParsedCode

r ​

Renderer

Returns ​

void

renderEllipsis() ​

renderEllipsis(p, r): void

Defined in: render.ts:95

Parameters ​

p ​

ParsedEllipsis

r ​

Renderer

Returns ​

void

renderEmail() ​

renderEmail(p, r): void

Defined in: render.ts:97

Parameters ​

p ​

ParsedEmail

r ​

Renderer

Returns ​

void

renderEmoji() ​

renderEmoji(p, r): void

Defined in: render.ts:99

Parameters ​

p ​

ParsedEmoji

r ​

Renderer

Returns ​

void

renderEvent() ​

renderEvent(p, r): void

Defined in: render.ts:114

Parameters ​

p ​

ParsedEvent

r ​

Renderer

Returns ​

void

renderInvoice() ​

renderInvoice(p, r): void

Defined in: render.ts:101

Parameters ​

p ​

ParsedInvoice

r ​

Renderer

Returns ​

void

renderLink(p, r): void

Defined in: render.ts:104

Parameters ​

p ​

ParsedLink

r ​

Renderer

Returns ​

void

renderMany() ​

renderMany(parsed, renderer): Renderer

Defined in: render.ts:168

Parameters ​

parsed ​

Parsed[]

renderer ​

Renderer

Returns ​

Renderer

renderNewline() ​

renderNewline(p, r): void

Defined in: render.ts:107

Parameters ​

p ​

ParsedNewline

r ​

Renderer

Returns ​

void

renderOne() ​

renderOne(parsed, renderer): Renderer

Defined in: render.ts:122

Parameters ​

parsed ​

Parsed

renderer ​

Renderer

Returns ​

Renderer

renderProfile() ​

renderProfile(p, r): void

Defined in: render.ts:116

Parameters ​

p ​

ParsedProfile

r ​

Renderer

Returns ​

void

renderText() ​

renderText(p, r): void

Defined in: render.ts:110

Parameters ​

p ​

ParsedText

r ​

Renderer

Returns ​

void

renderTopic() ​

renderTopic(p, r): void

Defined in: render.ts:112

Parameters ​

p ​

ParsedTopic

r ​

Renderer

Returns ​

void

truncate() ​

truncate(content, __namedParameters): Parsed[]

Defined in: parser.ts:445

Parameters ​

content ​

Parsed[]

__namedParameters ​

TruncateOpts = {}

Returns ​

Parsed[]

urlIsMedia() ​

urlIsMedia(url): boolean

Defined in: parser.ts:7

Parameters ​

url ​

string

Returns ​

boolean