ReactiveX/rxjs

Document ISubscription to SubscriptionLike breaking change

Open

#3681 opened on May 10, 2018

View on GitHub
 (1 comment) (2 reactions) (0 assignees)TypeScript (31,024 stars) (3,007 forks)batch import
docshelp wanted

Description

RxJS version: 6.1.0

Code to reproduce:

import { ISubscription } from 'rxjs/Subscription';

Expected behavior:

import { SubscriptionLike } from 'rxjs';

Actual behavior:

No documentation for this change is mentioned in MIGRATION.md#import-paths

Additional information:

Please include an update about this breaking change https://github.com/ReactiveX/rxjs/blob/master/MIGRATION.md#import-paths

Contributor guide

Tech stack
typescript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
Update the MIGRATION.md file under the #import paths section to include a note about the breaking change from ISubscription to SubscriptionLike. See the existing documentation at https://github.com/ReactiveX/rxjs/blob/master/MIGRATION.md#import paths for the current content.