downshift-js/downshift

TypeScript: have items and selectedItems as Readonly

Open

#1 030 ouverte le 30 avr. 2020

Voir sur GitHub
 (4 commentaires) (1 réaction) (0 assignés)JavaScript (11 761 stars) (980 forks)batch import
TypeScripthelp wanted

Description

  • downshift version:
  • node version:
  • npm (or yarn) version:

Relevant code or config

What you did:

What happened:

Reproduction repository:

Problem description: Since we use items/selectedItems just for some logic and we do not tamper with them, we can mark them as read only in the TS interface.

Suggested solution: In typings.ts for useSelect, useCombobox and useMultipleSelection, use Readonly to wrap the items type.

Guide contributeur

Stack technique
typescriptreact
Domaine
frontend
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic TypeScript knowledgeFamiliarity with downshift typings
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90
Direction de recherche
Locate typings.ts file in the downshift source code. For hooks useSelect, useCombobox, and useMultipleSelection, modify the type definitions to wrap the items and selectedItems properties with Readonly<T> to indicate they are not mutated. Ensure consistency across all three hooks. No logic changes required.