ReactiveX/rxjs

Document ISubscription to SubscriptionLike breaking change

Closed

#3,681 opened on May 10, 2018

View on GitHubContributor guide
 (1 comment) (2 reactions) (0 assignees)TypeScript (2,990 forks)batch import
docshelp wanted

Repository metrics

Stars
 (31,707 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Update MIGRATION.md to document the breaking change from ISubscription to SubscriptionLike, including the new import path and deprecation notice.
Tech stack
typescriptjavascript
Domain
frontendbackend
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.
Fresh
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.
90