meilisearch Write meilisearch-js TSDoc
Shape
Match nearby methods in the same file. Typical experimental method:
/**
* Get a dynamic search rule
*
* @param uid - Dynamic search rule UID
* @returns Promise returning the dynamic search rule
* @experimental
* @see {@link https://www.meilisearch.com/docs/reference/api/search-rules/get-a-search-rule}
*/
Stable methods: omit @experimental. Keep @param / @returns as needed.
Rules
- Link the matching API reference page with
@see {@link https://www.meilisearch.com/docs/...} - Resolve URLs from https://www.meilisearch.com/docs/llms.txt (prefer current paths over aliases)
- Mark experimental APIs with
@experimentalonly - Do not put Meilisearch version requirements in method prose (hard to keep accurate)
- Do not add a trailing period on the summary line
- Do not invent docs URLs; if no page exists, link the closest related API reference page
Check
pnpm style:fix(TSDoc lint runs via oxlint)