Class HelpApi

Index

Constructors

Methods

apiTopic commandTopic fullTopic index listKind search typeahead

Constructors

constructor

new HelpApi(): HelpApi
Returns HelpApi

Methods

`Static`apiTopic

apiTopic(target: string, viewer?: HelpViewer): HelpTopic | null
Resolve an api/mixin/type topic by id / Type.member / bare name.
Parameters
- target: string
- viewer: HelpViewer = FLOOR
Returns HelpTopic | null
- Defined in packages/server/src/mud/api/help.ts:143

`Static`commandTopic

commandTopic(verb: string, viewer?: HelpViewer): HelpTopic | null
Resolve a command topic by verb (or alias), or null.
Parameters
- verb: string
- viewer: HelpViewer = FLOOR
Returns HelpTopic | null
- Defined in packages/server/src/mud/api/help.ts:128

`Static`fullTopic

fullTopic(id: string, viewer?: HelpViewer): HelpTopic | null
A single full topic by id (body + relations), or null.
Parameters
- id: string
- viewer: HelpViewer = FLOOR
Returns HelpTopic | null
- Defined in packages/server/src/mud/api/help.ts:90

`Static`index

index(viewer?: HelpViewer): HelpIndexResult
Light index slice + the category descriptors.
Parameters
- viewer: HelpViewer = FLOOR
Returns HelpIndexResult
- Defined in packages/server/src/mud/api/help.ts:63

`Static`listKind

listKind(kind: HelpKind, viewer?: HelpViewer): HelpKindListResult
Every topic of one kind (category drill-in).
Parameters
- kind: HelpKind
- viewer: HelpViewer = FLOOR
Returns HelpKindListResult
- Defined in packages/server/src/mud/api/help.ts:75

`Static`search

search(q: string, viewer?: HelpViewer): HelpSearchResult
Search by query, results grouped by kind.
Parameters
- q: string
- viewer: HelpViewer = FLOOR
Returns HelpSearchResult
- Defined in packages/server/src/mud/api/help.ts:102

`Static`typeahead

typeahead(q: string, viewer?: HelpViewer): HelpIndexEntry[]
Client-local typeahead candidates.
Parameters
- q: string
- viewer: HelpViewer = FLOOR
Returns HelpIndexEntry[]
- Defined in packages/server/src/mud/api/help.ts:117