Skip to content

Add a short request timeout example to endpoint docs #10

@TDanks2000

Description

@TDanks2000

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions