Skip to content

Commit

Permalink
docs: fix broken links in documentation (#6380)
Browse files Browse the repository at this point in the history
  • Loading branch information
tmair committed May 21, 2021
1 parent e2f2e51 commit f7ea211
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
20 changes: 10 additions & 10 deletions src/internal/Notification.ts
Expand Up @@ -44,21 +44,21 @@ export class Notification<T> {
* Creates a "Next" notification object.
* @param kind Always `'N'`
* @param value The value to notify with if observed.
* @deprecated Internal implementation detail. Use {@link createNext} instead.
* @deprecated Internal implementation detail. Use {@link Notification#createNext createNext} instead.
*/
constructor(kind: 'N', value?: T);
/**
* Creates an "Error" notification object.
* @param kind Always `'E'`
* @param value Always `undefined`
* @param error The error to notify with if observed.
* @deprecated Internal implementation detail. Use {@link createError} instead.
* @deprecated Internal implementation detail. Use {@link Notification#createError createError} instead.
*/
constructor(kind: 'E', value: undefined, error: any);
/**
* Creates a "completion" notification object.
* @param kind Always `'C'`
* @deprecated Internal implementation detail. Use {@link createComplete} instead.
* @deprecated Internal implementation detail. Use {@link Notification#createComplete createComplete} instead.
*/
constructor(kind: 'C');
constructor(public readonly kind: 'N' | 'E' | 'C', public readonly value?: T, public readonly error?: any) {
Expand All @@ -82,7 +82,7 @@ export class Notification<T> {
* @param next A next handler
* @param error An error handler
* @param complete A complete handler
* @deprecated Replaced with {@link Notification.prototype.observe}. Will be removed in v8.
* @deprecated Replaced with {@link Notification#observe observe}. Will be removed in v8.
*/
do(next: (value: T) => void, error: (err: any) => void, complete: () => void): void;
/**
Expand All @@ -91,14 +91,14 @@ export class Notification<T> {
* and no error is thrown, it will be a noop.
* @param next A next handler
* @param error An error handler
* @deprecated Replaced with {@link Notification.prototype.observe}. Will be removed in v8.
* @deprecated Replaced with {@link Notification#observe observe}. Will be removed in v8.
*/
do(next: (value: T) => void, error: (err: any) => void): void;
/**
* Executes the next handler if the Notification is of `kind` `"N"`. Otherwise
* this will not error, and it will be a noop.
* @param next The next handler
* @deprecated Replaced with {@link Notification.prototype.observe}. Will be removed in v8.
* @deprecated Replaced with {@link Notification#observe observe}. Will be removed in v8.
*/
do(next: (value: T) => void): void;
do(nextHandler: (value: T) => void, errorHandler?: (err: any) => void, completeHandler?: () => void): void {
Expand All @@ -113,7 +113,7 @@ export class Notification<T> {
* @param next A next handler
* @param error An error handler
* @param complete A complete handler
* @deprecated Replaced with {@link Notification.prototype.observe}. Will be removed in v8.
* @deprecated Replaced with {@link Notification#observe observe}. Will be removed in v8.
*/
accept(next: (value: T) => void, error: (err: any) => void, complete: () => void): void;
/**
Expand All @@ -122,14 +122,14 @@ export class Notification<T> {
* and no error is thrown, it will be a noop.
* @param next A next handler
* @param error An error handler
* @deprecated Replaced with {@link Notification.prototype.observe}. Will be removed in v8.
* @deprecated Replaced with {@link Notification#observe observe}. Will be removed in v8.
*/
accept(next: (value: T) => void, error: (err: any) => void): void;
/**
* Executes the next handler if the Notification is of `kind` `"N"`. Otherwise
* this will not error, and it will be a noop.
* @param next The next handler
* @deprecated Replaced with {@link Notification.prototype.observe}. Will be removed in v8.
* @deprecated Replaced with {@link Notification#observe observe}. Will be removed in v8.
*/
accept(next: (value: T) => void): void;

Expand All @@ -138,7 +138,7 @@ export class Notification<T> {
* If the handler is missing it will do nothing. Even if the notification is an error, if
* there is no error handler on the observer, an error will not be thrown, it will noop.
* @param observer The observer to notify.
* @deprecated Replaced with {@link Notification.prototype.observe}. Will be removed in v8.
* @deprecated Replaced with {@link Notification#observe observe}. Will be removed in v8.
*/
accept(observer: PartialObserver<T>): void;
accept(nextOrObserver: PartialObserver<T> | ((value: T) => void), error?: (err: any) => void, complete?: () => void) {
Expand Down
2 changes: 1 addition & 1 deletion src/internal/config.ts
Expand Up @@ -43,7 +43,7 @@ export interface GlobalConfig {
onStoppedNotification: ((notification: ObservableNotification<any>, subscriber: Subscriber<any>) => void) | null;

/**
* The promise constructor used by default for {@link toPromise} and {@link forEach}
* The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}
* methods.
*
* @deprecated As of version 8, RxJS will no longer support this sort of injection of a
Expand Down
2 changes: 1 addition & 1 deletion src/internal/observable/ConnectableObservable.ts
Expand Up @@ -60,7 +60,7 @@ export class ConnectableObservable<T> extends Observable<T> {
}

/**
* @deprecated {@link ConnectableObservable} will be removed in v8. Use {@link connecatble} instead.
* @deprecated {@link ConnectableObservable} will be removed in v8. Use {@link connectable} instead.
* Details: https://rxjs.dev/deprecations/multicasting
*/
connect(): Subscription {
Expand Down

0 comments on commit f7ea211

Please sign in to comment.