redux-utilities/flux-standard-action

Adding types with optional properties made required

Open

#109 opened on May 15, 2018

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (4,744 stars) (154 forks)batch import
enhancementhelp wanted

Description

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.

Contributor guide

Tech stack
javascripttypescript
Domain
frontenddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScriptFlux Standard Action basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.