Skip to content

[Doc] Client configuration docs changes #24362

@peisenmann

Description

@peisenmann

Search before reporting

  • I searched in the issues and found nothing similar.

What issue do you find in Pulsar docs?

The docs page for the Node client does not seem to document:

  • useTLS: boolean
  • logLevel: 0, 1, 2, 3 (0 correlates to debug, 1=info, 2=warn, 3=error)

These are, however, captured in the TS types: https://github.com/apache/pulsar-client-node/blob/master/index.d.ts#L21

Further, these defaults are not captured anywhere as far as I can tell:

What is your suggestion?

I think documenting these things is enough. If there are other places where configurations are inferred or defaulted but not documented, it would be nice to find those and include them, too, but these are the ones I've come across so far.

Any reference?

No response

Are you willing to submit a PR?

  • I'm willing to submit a PR!

Metadata

Metadata

Assignees

No one assigned

    Labels

    doc-requiredYour PR changes impact docs and you will update later.

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions