apache / apache/pulsar-client-node
Documentation for ClientConfig parameters?
- Langage dominant
- C++
- Étoiles
- 164
- Forks
- 98
- Métriques de merge des PR
- Aucune PR mergée en 30 j
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.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Piste de recherche
Commencez par inspecter les déclarations des paramètres de ClientConfig dans index.d.ts aux lignes 25-33 et vérifiez si une documentation existe ailleurs dans le dépôt. Documentez les paramètres dans la définition TypeScript ou identifiez l’emplacement de la documentation existante, et vérifiez que les utilisateurs peuvent trouver les descriptions des paramètres pendant le développement.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- nodejs, typescript
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100