apache / apache/pulsar-client-node

Documentation for ClientConfig parameters?

Aperta
#195 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
C++
Stelle
164
Fork
98
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Inizia ispezionando le dichiarazioni dei parametri di ClientConfig in index.d.ts alle righe 25-33 e verifica se esiste documentazione altrove nel repository. Documenta i parametri nella definizione TypeScript oppure individua la posizione della documentazione esistente, e verifica che gli utenti possano trovare le descrizioni dei parametri durante lo sviluppo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
nodejs, typescript
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.