apache / apache/pulsar-client-node

Documentation for ClientConfig parameters?

Open
#195 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
164
Forks
98
PR merge metrics
No merged PRs in 30d

Description

Hi,
There are multiple parameter settings for the ClientConfig,
https://github.com/apache/pulsar-client-node/blob/d2c0d1e374f8e9f25934bd679436da0872b6bc8e/index.d.ts#L25-L33

Is the documentation for these parameters available somewhere? Ideally I'd suggest adding some comments directly in the typescript definition, so users of the library can see some documentation while developing.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inspecting the ClientConfig parameter declarations in index.d.ts at lines 25-33 and check whether documentation exists elsewhere in the repository. Document the parameters in the TypeScript definition, or identify the existing documentation location, and verify that users can find the parameter descriptions while developing.

Written by the indexing model from the issue text.

Assessment

Tech stack
nodejs, typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.