downshift-js/downshift

TypeScript: have items and selectedItems as Readonly

Open

#1,030 opened on 2020年4月30日

GitHub で見る
 (4 comments) (1 reaction) (0 assignees)JavaScript (11,761 stars) (980 forks)batch import
TypeScripthelp wanted

説明

  • 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.

コントリビューターガイド

技術スタック
typescriptreact
領域
frontend
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Basic TypeScript knowledgeFamiliarity with downshift typings
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90
調査方針
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.
TypeScript: have items and selectedItems as Readonly · downshift-js/downshift#1030 | Good First Issue