redux-utilities/flux-standard-action

Adding types with optional properties made required

Open

#109 创建于 2018年5月15日

在 GitHub 查看
 (4 评论) (0 反应) (0 负责人)JavaScript (4,744 star) (154 fork)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
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
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.