pulsar-client-node Documentation for ClientConfig parameters?

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.

Feb 23 '22 07:02 larshp

I suspect this overlaps with pulsar-client-cpp, I didn't find docs for that (I think it's provided in the header files) but there is an equivalent overlap with the java client - https://pulsar.apache.org/api/client/2.10.0-SNAPSHOT/org/apache/pulsar/client/api/ClientBuilder.html

Feb 26 '22 12:02 Matt-Esch

@larshp Did you see the official documentation? https://pulsar.apache.org/docs/en/client-libraries-node/#client-configuration It is not for the type definition(index.d.ts). However, it is most likely useful.

Mar 03 '22 09:03 equanz

@equanz thanks, that helps

but as a user, how do I find that documentation? I lookup the npm package on https://www.npmjs.com/package/pulsar-client, check the git repository https://github.com/apache/pulsar-client-node, and I cannot find any links to the documentation linked above?

Mar 03 '22 09:03 larshp

but as a user, how do I find that documentation? I lookup the npm package on https://www.npmjs.com/package/pulsar-client, check the git repository https://github.com/apache/pulsar-client-node, and I cannot find any links to the documentation linked above?

You're right! It would be better to add the link to this repository.

Mar 03 '22 10:03 equanz