Links API

Functions for querying link relationships between pages.

wiki.getLinks()

Gets the outgoing links from a page (what the page links to).

Signature:

getLinks(id: string): string[]

Parameters:

Returns: string[] — Array of link texts as written in content

Example:

await wiki.createPage({
  title: 'Story',
  content: 'The [[Hero]] found the [[Magic Sword]].'
})

const links = wiki.getLinks('story')
console.log(links) // ['Hero', 'Magic Sword']

wiki.getBacklinks()

Gets pages that link to this page.

Signature:

getBacklinks(id: string): string[]

Parameters:

Returns: string[] — Array of page IDs that link to this page

Example:

await wiki.createPage({ title: 'Hero', content: '' })
await wiki.createPage({ title: 'Story', content: 'The [[Hero]] wins.' })
await wiki.createPage({ title: 'Ending', content: 'The [[Hero]] celebrates.' })

const backlinks = wiki.getBacklinks('hero')
console.log(backlinks) // ['story', 'ending']

wiki.getLinkedPages()

Gets full page objects for pages this page links to.

Signature:

getLinkedPages(id: string): WikiPage[]

Parameters:

Returns: WikiPage[] — Array of linked pages (excludes dead links)

Example:

await wiki.createPage({ title: 'Hero', content: '' })
await wiki.createPage({
  title: 'Story',
  content: '[[Hero]] and [[Missing]]'
})

const linkedPages = wiki.getLinkedPages('story')
console.log(linkedPages.length) // 1 (only Hero exists)
console.log(linkedPages[0].title) // 'Hero'

wiki.getBacklinkPages()

Gets full page objects for pages that link to this page.

Signature:

getBacklinkPages(id: string): WikiPage[]

Parameters:

Returns: WikiPage[] — Array of pages that link here

Example:

const backlinkPages = wiki.getBacklinkPages('hero')
for (const page of backlinkPages) {
  console.log(`${page.title} links to Hero`)
}

wiki.resolveLink()

Converts link text to a page ID.

Signature:

resolveLink(linkText: string): string

Parameters:

Returns: string — The slugified page ID

Example:

const id = wiki.resolveLink('King Aldric')
console.log(id) // 'king-aldric'

const id = wiki.resolveLink('Café München')
console.log(id) // 'cafe-munchen'

wiki.resolveLinkToPage()

Converts link text to the target page, if it exists.

Signature:

resolveLinkToPage(linkText: string): WikiPage | undefined

Parameters:

Returns: WikiPage | undefined — The target page if it exists

Example:

await wiki.createPage({ title: 'King Aldric', content: '' })

const page = wiki.resolveLinkToPage('King Aldric')
if (page) {
  console.log(page.id) // 'king-aldric'
}

const missing = wiki.resolveLinkToPage('Unknown')
console.log(missing) // undefined