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

fix(data): type overloaded add for is optimistic true | undefined #2906

Merged

Conversation

yharaskrik
Copy link
Contributor

@yharaskrik yharaskrik commented Jan 31, 2021

TypeScript only recognizes the overloads as method signatures when being overloaded not the actual implementation, added overload for the case where isOptimistic is true or undefined (default for entity).

This will allow for the following:

.add(entityWithoutId, { isOptimistic: false })
.add(entityWithId, { isOptimistic: true })
.add(entityWithId, { // any other options with whatever settings and no explicit value for isOptimistic })
.add(entityWithId)

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[x] Bugfix
[ ] 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:

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

Resolves this comment #2899 (comment)

TypeScript only recognizes the overloads as method signatures when being overloaded not the actual implementation, added overload for the case where isOptimistic is true or undefined (default for entity).

This will allow for the following:

`.add(entityWithoutId, { isOptimistic: false })`
`.add(entityWithId, { isOptimistic: true })`
`.add(entityWithId, { // any other options without whatever settings and no explicit value for isOptimistic })`
`.add(entityWithId)`
@ngrxbot
Copy link
Collaborator

ngrxbot commented Jan 31, 2021

Preview docs changes for 8da6f4e at https://previews.ngrx.io/pr2906-8da6f4ec/

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.

3 participants