Class: Docs
Defined in: packages/docs/src/docs.ts:53
A docs site's content in the page: search by words at once, by meaning once the reader has an embedding model, and the tools an assistant (or the browser's own agents) uses to read the docs.
Constructors
Constructor
new Docs(
ai,options):Docs
Defined in: packages/docs/src/docs.ts:64
Parameters
ai
Leuria
options
Returns
Docs
Properties
ai
readonlyai:Leuria
Defined in: packages/docs/src/docs.ts:65
index?
optionalindex?:VectorIndex<{url:string; }>
Defined in: packages/docs/src/docs.ts:61
Search by meaning, built with the reader's model; created once the corpus is loaded.
Accessors
pages
Get Signature
get pages():
DocsPage[]
Defined in: packages/docs/src/docs.ts:84
Returns
DocsPage[]
pageTools
Get Signature
get pageTools():
ToolDefinition<Record<string,unknown>,unknown>[]
Defined in: packages/docs/src/docs.ts:170
Tools for the browser's own agents (WebMCP): the same, plus opening a page for the reader.
Returns
ToolDefinition<Record<string, unknown>, unknown>[]
site
Get Signature
get site():
string|undefined
Defined in: packages/docs/src/docs.ts:80
Returns
string | undefined
tools
Get Signature
get tools():
ToolDefinition<Record<string,unknown>,unknown>[]
Defined in: packages/docs/src/docs.ts:165
Tools for the docs assistant: search, read a page, list the pages.
Returns
ToolDefinition<Record<string, unknown>, unknown>[]
Methods
currentPage()
currentPage():
DocsPage|undefined
Defined in: packages/docs/src/docs.ts:99
The page open on screen, if it is a docs page.
Returns
DocsPage | undefined
destroy()
destroy():
void
Defined in: packages/docs/src/docs.ts:179
Returns
void
expose()
expose(): () =>
void
Defined in: packages/docs/src/docs.ts:175
Offer pageTools to the browser's agents; returns how to take them back.
Returns
() => void
load()
load():
Promise<DocsCorpus>
Defined in: packages/docs/src/docs.ts:73
The corpus, fetched on first use.
Returns
Promise<DocsCorpus>
meaningState()
meaningState():
IndexState|undefined
Defined in: packages/docs/src/docs.ts:109
Search by meaning: waiting for a model, indexing, ready.
Returns
IndexState | undefined
open()
open(
url):void
Defined in: packages/docs/src/docs.ts:160
Show a page to the reader.
Parameters
url
string
Returns
void
page()
page(
url):DocsPage|undefined
Defined in: packages/docs/src/docs.ts:89
The page at this address (any form: full URL, trailing slash, hash).
Parameters
url
string
Returns
DocsPage | undefined
search()
search(
query,__namedParameters?):Promise<DocsHit[]>
Defined in: packages/docs/src/docs.ts:120
Search the docs: by words at once, merged with search by meaning when it is ready.
Parameters
query
string
__namedParameters?
DocsSearchOptions = {}
Returns
Promise<DocsHit[]>
section()
section(
id):DocsSection|undefined
Defined in: packages/docs/src/docs.ts:94
A section by its id (url#anchor).
Parameters
id
string
Returns
DocsSection | undefined
subscribe()
subscribe(
listener): () =>void
Defined in: packages/docs/src/docs.ts:114
Be told when the corpus loads or search by meaning changes state.
Parameters
listener
() => void
Returns
() => void
version()
version():
string|undefined
Defined in: packages/docs/src/docs.ts:104
The version the reader is on.
Returns
string | undefined