Skip to content

fix:toSelectArray breaking change + document toArray change #184

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

Merged
merged 2 commits into from
Oct 22, 2020

Conversation

atymic
Copy link
Contributor

@atymic atymic commented Oct 11, 2020

  • Added or updated tests
  • Added or updated the README.md
  • Detailed changes in the CHANGELOG.md unreleased section

Related Issue/Intent

This PR is kind of a combination of a few issues. Mainly, it fixes the breaking change that was renaming toSelectArray() on a minor version.

This broke a few of my apps, and broke another client's app today.

There was also another breaking change (switching the behaviour of toArray). I understand this was done to match the v1 behaviour, but I think this should have been a major version bump.

I don't think it's a good idea to change this again, as it would be another breaking change, so I've added a readme section to show how you can restore that behaviour.

Changes

  • Fix toSelectArray breaking change by reinstating method (but marking is as deprecated)
  • Add readme documentation of returning previous v2 toArray behaviour.

Breaking changes

None.

Resolves #170

@atymic atymic changed the title fix: fix toSelectArray breaking change + document toArray change fix:toSelectArray breaking change + document toArray change Oct 11, 2020
@BenSampo BenSampo merged commit b08130a into BenSampo:master Oct 22, 2020
@BenSampo
Copy link
Owner

Thanks @atymic - I learned from both of those mistakes - I appreciate you taking the time to lessen the impact of them. Sorry if it caused you bother with the apps that broke.

@atymic atymic deleted the fix/bc-breaks branch October 22, 2020 22:11
@atymic
Copy link
Contributor Author

atymic commented Oct 22, 2020

No worries, I've done the same thing before 👍
Time saved by your awesome package is much greater!

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.

Breaking changes in minor version
2 participants