Skip to main content

Interface: DocsHit

Defined in: packages/docs/src/docs.ts:42

Properties​

heading?​

optional heading?: string

Defined in: packages/docs/src/docs.ts:49

href​

href: string

Defined in: packages/docs/src/docs.ts:46

Where to send the reader: the page, and the section's anchor.

id​

id: string

Defined in: packages/docs/src/docs.ts:44

The section: url#anchor.

passage?​

optional passage?: string

Defined in: packages/docs/src/docs.ts:53

The text the site's search found, when it gives one.

snippet​

snippet: string

Defined in: packages/docs/src/docs.ts:51

The start of the section's text, without its heading.

title​

title: string

Defined in: packages/docs/src/docs.ts:48

url​

url: string

Defined in: packages/docs/src/docs.ts:47

via​

via: "words" | "meaning" | "both"

Defined in: packages/docs/src/docs.ts:55

Found by words, by meaning, or both.