redux-utilities/flux-standard-action

Adding types with optional properties made required

Open

#109 opened on 2018年5月15日

GitHub で見る
 (4 comments) (0 reactions) (0 assignees)JavaScript (4,744 stars) (154 forks)batch import
enhancementhelp wanted

説明

Properties payload, error, and meta are all optional properties according to documentation. However I believe there are cases where actions may need to make these properties required ( such as actions based around a text search ). Adding interfaces such as those suggested by @dsanders1234 in a previous issue about these options not being correctly typed as optional strikes me as a good approach, and I'm thinking of doing something similar as a workaround. The standard FluxStandardAction could remain in place while those additional versions could be used as needed.

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

技術スタック
javascripttypescript
領域
frontenddeveloper experience
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
TypeScriptFlux Standard Action basics
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70
調査方針
Create additional TypeScript interfaces for FluxStandardAction that allow making the optional properties (payload, error, meta) required. Refer to the suggestion by @dsanders1234 in issue #100. Examine the existing type definitions in the repository (likely index.d.ts) and add interfaces such as RequiredPayloadAction or similar. Ensure backward compatibility by keeping the existing FluxStandardAction unchanged. Submit a pull request with the changes.
Adding types with optional properties made required · redux-utilities/flux-standard-action#109 | Good First Issue