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(effects): change the signature of provideEffect #3587

Merged
merged 1 commit into from
Oct 17, 2022

Conversation

timdeschryver
Copy link
Member

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?

Closes #

What is the new behavior?

Does this PR introduce a breaking change?

[x] Yes
[ ] No

BREAKING CHANGE:

The signature of provideEffects is changed to expect a spreaded array of effects.

BEFORE:

provideEffects expecteded the effects to be passed as an array.

// single effect
provideEffects([MyEffect])

// multiple effects
provideEffects([MyEffect, MySecondEffect])

AFTER:

provideEffects expects the effects as a spreaded array as argument.

// single effect
provideEffects(MyEffect)

// multiple effects
provideEffects(MyEffect, MySecondEffect)

BREAKING CHANGE:

The signature of `provideEffects` is changed to expect a
spreaded array of effects.

BEFORE:

`provideEffects` expecteded the effects to be passed as an array.

```ts
// single effect
provideEffects([MyEffect])

// multiple effects
provideEffects([MyEffect, MySecondEffect])
```ts

AFTER:

`provideEffects` expects the effects as a spreaded array as argument.

```ts
// single effect
provideEffects(MyEffect)

// multiple effects
provideEffects(MyEffect, MySecondEffect)
```ts
@netlify
Copy link

netlify bot commented Sep 24, 2022

Deploy Preview for ngrx-io canceled.

Name Link
🔨 Latest commit ffebbc8
🔍 Latest deploy log https://app.netlify.com/sites/ngrx-io/deploys/632f2a3a1712540008b71b9b

@twittwer
Copy link

👍 Cool, I was just looking if anyone already proposed this signature change

@brandonroberts brandonroberts merged commit 899afe7 into master Oct 17, 2022
@brandonroberts brandonroberts deleted the feat/provide-effect branch October 17, 2022 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants