Background
Most endpoint methods accept a RequestConfig as the last argument, and the package documents per-request timeoutMs. A small endpoint-level example would help users apply that pattern without reading multiple docs pages.
Proposed Change
Add one concise example showing a representative endpoint call with { timeoutMs: 5_000 } as the final argument.
Acceptance Criteria
- The example uses an endpoint signature that accepts
RequestConfig.
- The example places request config as the final argument.
- The docs link to
docs/request-config.md for more detail.
- No API behavior changes are made.
Files Likely Involved
docs/request-config.md
docs/endpoints/search.md
docs/examples.md
Background
Most endpoint methods accept a
RequestConfigas the last argument, and the package documents per-requesttimeoutMs. A small endpoint-level example would help users apply that pattern without reading multiple docs pages.Proposed Change
Add one concise example showing a representative endpoint call with
{ timeoutMs: 5_000 }as the final argument.Acceptance Criteria
RequestConfig.docs/request-config.mdfor more detail.Files Likely Involved
docs/request-config.mddocs/endpoints/search.mddocs/examples.md