singhvishalkr opened a new pull request, #1127:
URL: https://github.com/apache/pulsar-site/pull/1127

   ## Summary
   
   Closes #24362.
   
   The Node.js client config table in `client-libraries-node-configs.md` was 
missing several fields that are exposed by `ClientConfig` in 
[`apache/pulsar-client-node/index.d.ts`](https://github.com/apache/pulsar-client-node/blob/master/index.d.ts).
 This PR adds rows for:
   
   - `tlsCertificateFilePath` / `tlsPrivateKeyFilePath` -- client-side mTLS 
material.
   - `listenerName` -- picks an advertised listener when the broker exposes 
more than one.
   - `logLevel` -- defaults to `LogLevel.INFO` per 
[`src/Client.h`](https://github.com/apache/pulsar-client-node/blob/master/src/Client.h)
 (`pulsar_logger_level_t::pulsar_INFO`).
   - `connectionTimeoutMs`.
   
   It also surfaces the previously-undocumented default for 
`tlsTrustCertsFilePath`: when left unset, the JS wrapper in 
[`src/Client.js`](https://github.com/apache/pulsar-client-node/blob/master/src/Client.js)
 falls back to a bundled `cert.pem` seeded from Node.js's 
`tls.rootCertificates` at install time via `Client.genCertFile()`. Callers who 
hit certificate errors in restricted environments often rediscover this the 
hard way; documenting it should save a few debugging cycles.
   
   ### Note on `useTLS`
   
   The filing issue mentioned `useTLS` as undocumented, but `useTLS` is not 
present in the current `ClientConfig` interface on master, so I've not added a 
row for it. Happy to add one if it's still accepted by the native binding under 
a different name.
   
   ## Scope
   
   - `docs/client-libraries-node-configs.md` (tip / unreleased).
   - `versioned_docs/version-4.2.x/client-libraries-node-configs.md` (latest 
stable).
   
   Older versioned copies are left untouched -- some of the newly-documented 
fields (`connectionTimeoutMs`, `listenerName`) may not have existed in every 
older release; happy to backport on request once a maintainer confirms the 
earliest version.
   
   ## Test Plan
   
   - Table columns rendered manually against docusaurus `yarn start` locally.
   - Field names + defaults cross-checked against 
[`index.d.ts`](https://github.com/apache/pulsar-client-node/blob/master/index.d.ts)
 and 
[`src/Client.h`](https://github.com/apache/pulsar-client-node/blob/master/src/Client.h)
 on `pulsar-client-node@master`.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to