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

feat(Entity) Deprecate addAll and rename it to setAll #2348

Merged
merged 3 commits into from
Feb 6, 2020

Conversation

elvisun
Copy link
Contributor

@elvisun elvisun commented Feb 5, 2020

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Currently addAll removes all existing entities and then add all, which is very confusing and bug-prone.
Closes #2330

What is the new behavior?

Deprecated addAll and added an identical setAll

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@@ -200,6 +210,7 @@ export function createSortedStateAdapter<T>(selectId: any, sort: any): any {
updateOne: createStateOperator(updateOneMutably),
upsertOne: createStateOperator(upsertOneMutably),
addAll: createStateOperator(addAllMutably),
Copy link
Member

Choose a reason for hiding this comment

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

I think you should rename addAllMutalby to setAllMutable and just point addAll and setAll to createStateOperator(setAllMutably).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@ngrxbot
Copy link
Collaborator

ngrxbot commented Feb 5, 2020

Preview docs changes for 2ecd958 at https://previews.ngrx.io/pr2348-2ecd958/

Copy link
Member

@timdeschryver timdeschryver left a comment

@elvisun elvisun requested a review from alex-okrushko February 6, 2020 18:02
Copy link
Member

@timdeschryver timdeschryver left a comment

Choose a reason for hiding this comment

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

LGTM

@brandonroberts brandonroberts merged commit 27f5059 into ngrx:master Feb 6, 2020
@brandonroberts
Copy link
Member

Thanks @elvisun!

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.

Rename entity addAll to replaceAll
5 participants