Skip to content

Add JSDoc to exported helpers in src/utils/searchUtils.ts #1104

Description

@nanaf6203-bit

Context

src/utils/searchUtils.ts exports filter-parsing/serialization helpers used by search UI, but exported functions lack JSDoc - in tension with the repo's jsdoc/require-jsdoc policy and with src/utils/secureId.ts-style documented utilities.

Problem

Contributors cannot tell parameter semantics (e.g., how locale affects URL keys) without reading implementations, and lint may flag new files inconsistently.

Proposed approach

Add concise JSDoc (purpose, params, returns, example) to each export; ensure npm run lint passes for the file.

Acceptance criteria

  • All exports documented
  • Lint clean for the file
  • Docs mention key locale behavior

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions