Skip to content

docs: Add JSDoc examples to Producer and Consumer classes #11

Description

@josedab

Description

The Producer and Consumer classes could benefit from inline JSDoc @example blocks.

Task

  • Add @example blocks to key methods: produce(), consume(), subscribe(), close()
  • Examples should be practical and copy-pasteable
  • Run npm run build to verify no TypeScript errors

Helpful Context

  • See existing JSDoc in src/
  • Run npx typedoc to preview generated docs

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