docs: standardize TSDoc comments across result parsers and core interfaces

[typicalninja]

This PR standardizes the TSDoc documentation across all result parsers and core internal interfaces to improve developer and contributor experience.

Changes

• Result Parsers: Unified JSDoc format with consistent parameter documentation, practical examples, and proper type linking across all 8 result parsers
• Core Interfaces: Enhanced documentation for SearchOptions and SearchOptionsWithPages with detailed examples and better explanations of configuration options
• Utility Functions: Improved internal function documentation and standardized visibility tags

All changes are documentation-only with no functional modifications to the codebase.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 629c517

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[pkg-pr-new]

npm i https://pkg.pr.new/google-sr@97

npm i https://pkg.pr.new/google-sr-selectors@97

npm i https://pkg.pr.new/google-that@97

commit: 629c517

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.49%. Comparing base (51580a6) to head (629c517).
⚠️ Report is 2 commits behind head on master.
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@           Coverage Diff           @@
##           master      #97   +/-   ##
=======================================
  Coverage   98.49%   98.49%           
=======================================
  Files          13       13           
  Lines         532      532           
  Branches      110      110           
=======================================
  Hits          524      524           
  Misses          8        8           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[Copilot]

Pull Request Overview

This PR standardizes TSDoc comments across result parsers and core interfaces to improve developer experience and maintain consistent documentation patterns throughout the codebase.

• Enhanced JSDoc documentation with proper parameter descriptions, practical examples, and return type specifications
• Standardized internal utility function documentation with @internal tags and improved descriptions
• Improved core interface documentation with detailed configuration explanations and usage examples

Reviewed Changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
packages/google-sr/src/utils.ts	Updated utility function documentation with proper TSDoc format and @internal tags
packages/google-sr/src/search.ts	Added comprehensive documentation for main search functions with examples
packages/google-sr/src/results/*.ts	Standardized result parser documentation across all 8 parsers with consistent format and examples
packages/google-sr/src/index.ts	Added utility type exports with clarifying comment
packages/google-sr/src/constants.ts	Enhanced SearchOptions interface documentation with detailed parameter explanations

Comments suppressed due to low confidence (1)

packages/google-sr/src/results/organic.ts:42

• The parameter name 'noPartialResult' should be 'noPartialResults' to match the actual parameter name.

 * - If noPartialResults is false: Array of {@link PartialExceptType}<{@link OrganicResultNode}> objects