valkey-io/valkey-glide

Node: Reduce Non-Null Assertions about BaseClient's config

Aperta

#2679 aperta il 13 nov 2024

Vedi su GitHubGuida contributor
 (5 commenti) (0 reazioni) (2 assegnatari)Java (166 fork)auto 404
Task 🔧Users Paingood first issuenode 🐢

Metriche repository

Star
 (762 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Description

I noticed that while the BaseClient constructor's options parameter is marked as optional (options?: BaseClientConfiguration), it's always provided with a non-null value in all creation paths through createClient()[1][2]. This creates an unnecessary nullable context that leads to multiple non-null assertions (!)[1][2][3] throughout the codebase.

This change would make the code more straightforward and remove potentially confusing null-checking context for developers first encountering the codebase. The nullable parameter currently serves no practical purpose since options are always provided during client creation.

Checklist

  • Make the options parameter required or give default value (e.g. {}) in the BaseClient constructor
  • Remove non-null assertions where this.config is used
  • Simplify the type safety guarantees

Additional Notes

No response

Guida contributor

Direzione di ricerca
Esamina la firma del costruttore di BaseClient e tutti i punti di chiamata in GlideClient.ts e GlideClusterClient.ts. Quindi rimuovi l'opzionalità del parametro options ed elimina le asserzioni non null nella classe.
Tech stack
typescriptnodejs
Dominio
backend
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
TypeScriptGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80