Giters

piotrwitek / typesafe-actions

Typesafe utilities for "action-creators" in Redux / Flux Architecture

Home Page:https://codesandbox.io/s/github/piotrwitek/typesafe-actions/tree/master/codesandbox

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Add support for an `error` field to `createAction`

piotrwitek opened this issue · comments

commented

Is your feature request related to a real problem or use-case?

Add support for an error field to createAction so it is compliant with Flux standard action specification.

This will open the possibility to use typesafe-actions with other solutions or applications that are relying on that pattern.

Describe a solution including usage in code example

  1. How it would work type-wise?
    Most probably an optional error field added to the base Action type:
type Action = {
  type: string;
  error?: boolean;
}
  1. How it would work at runtime?
    I would go with a forced convention by having a payload to be an instance of Error (easy to implement, backward compatible does not change API and I think that's the most popular option)

This would automatically set the error property to true, but also it could allow leveraging conditional types to refine Action type even further to show or hide error property from the action type. That would be the most optimal solution.

Who does this impact? Who is this for?

All users

Describe alternatives you've considered (optional)

Additional context (optional)

Related #108

commented

When I started working with your library, I naturally tried to pass an instance of Error to the createAction and I was secretly hoping that the boolean error was automatically set, but it wasn't.

So when I'm reading this:

I would go with a forced convention by having a payload to be an instance of Error (easy to implement, backward compatible does not change API and I think that's the most popular option)

This would automatically set the error property to true, but also it could allow leveraging conditional types to refine Action type even further to show or hide error property from the action type. That would be the most optimal solution.

I definitely agree 👍

commented

@ncuillery thanks for your feedback
Part 2) is quite easy so I consider accepting PRs with that part separately.

Part 1) is quite complex and most probably will need my expertise