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

docs(page): add breaking changes page #4841

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs_app/content/guide/v6/breaking-changes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Breaking Changes

RxJS introduces some breaking changes with the release of version 6. About the major release
breaking changes one can read all the important facts at the [pipeable operator](../pipeable-operators) and the corresponding [migration](../migration) page.

Unfortunately we recently introduces other breaking changes, which will be listed below.

<div class="alert is-important">
<span>
Please do note that it's highly possible that you aren't affected by a breaking change, eventhough you are migrating to that
particular version.
</span>
</div>

## [email protected]

### [email protected] Regression

RxJS itselfs already used TypeScript 2.8 for quite a while, but version 6.4 was the first version officially relying on features of TypeScript 2.8.
Unfortunately this might break your code if you used to use TypeScript 2.7. You also might run into this issue, when you are using Angular and the Angular CLI with the Version 6.0.X.

You will notice that you are affected by this breaking change when you try to build your application and run into an error looking similar to

```sh
ERROR in node_modules/rxjs/internal/types.d.ts(81,44): error TS1005: ';' expected
node_modules/rxjs/internal/types.d.ts(81,74): error TS1005: ';' expected.
node_modules/rxjs/internal/types.d.ts(81,77): error TS1109: Expression expected.
```

#### Solving the issue

For this particular issue you have two ways to fix it properly:

1. You could update your project to TypeScript version >= 2.8
In general most of the user of RxJS said that this update was flawless. This is likely possible because the Breaking Changes of TypeScript 2.8 are just affecting a very small user base. You can read about the Breaking Changes of TypeScript 2.8 [here](https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes#typescript-28).
2. You can pin your project to [email protected]
In general one should prefer the first option to keep up to date with all his dependencies. If there is really no way to migrate your project to TypeScript >= 2.8 than you can use the previous minor release of rxjs by strictly pinning it in your package.json file.
5 changes: 5 additions & 0 deletions docs_app/content/navigation.json
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,11 @@
"url": "api/deprecations",
"title": "Deprecations",
"tooltip": "List of Deprecations"
},
{
"url": "guide/v6/breaking-changes",
"title": "Breaking Changes",
"tooltip": "Detailed Description about Breaking Changes"
}
]
},
Expand Down