Skip to content

Commit 516f949

Browse files
committed
docs: add details about the rxjs version
Add details about the proper rxjs version to be installed during migration. Fix #54.
1 parent 2643f8e commit 516f949

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ For an Angular CLI project the invocation of `rxjs-5-to-6-migrate` will be:
2828
rxjs-5-to-6-migrate -p src/tsconfig.app.json
2929
```
3030

31+
**Note:** The rules use type checking to find all the instances of operators that need to be migrated to pipeables. This requires you to have `rxjs@5` installed so that tslint could find the correct type definitions.
32+
3133
## Use rules
3234

3335
To use the exported rules without `rxjs-5-to-6-migrate`, use the `rulesDirectory` configuration property of `tslint.json`:

0 commit comments

Comments
 (0)