Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use string literal type for action type #64

Merged
merged 1 commit into from
Aug 13, 2018

Conversation

OliverJAsh
Copy link
Contributor

No description provided.

@@ -17,7 +17,7 @@ declare module 'connected-react-router' {
action: 'POP' | 'PUSH'
}

export const LOCATION_CHANGE: string
export const LOCATION_CHANGE: '@@router/LOCATION_CHANGE'
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need to change this? How does it affect the result?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is needed for TypeScript's control flow analysis, e.g.:

const reducer = (state, action: LocationChangeAction | MyOtherAction) => {
  switch (action.type) {
    case LOCATION_CHANGE: {
      // Here, TypeScript knows `action` is type `LocationChangeAction`, and has a property called `payload`, which has a property called `location`
    }
  }
}

If the action type was not a string literal, TypeScript's control flow analysis wouldn't be able to narrow the union.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants