Блог

Я хочу расширить Observable класс rxjs5 с помощью статической функции. Я могу сделать это простым JavaScript:

 var myStaticFn = function() { /* ... */ };
Observable.myStaticFn = myStaticFn;
  

это работает, но в TypeScript я не могу получить доступ Observable.myStaticFn , поскольку свойство myStaticFn неизвестно в классе Observable .

Как мне объявить / дополнить класс модуля Observable rxjs5, чтобы я мог получить доступ к своей функции безопасным для типов способом?

Примечание: В качестве отправной точки ниже показан пример, как расширить нестатическую функцию до наблюдаемой (например, для создания пользовательского оператора rxjs), и это полностью работает, но это не то, что я хочу!

 function myOperator(this: Observable<any>): Observable<any> = function(){ /*...*/ };
Observable.prototype.myOperator = myOperator;

declare module "rxjs/Observable" {
    interface Observable<T> {
        myOperator: typeof myOperator;
    }
}
  

Вышеуказанное работает, потому declare что синтаксис TypeScript позволяет мне рассматривать Observable его как интерфейс, а интерфейсы могут быть расширены / объединены. Но в TypeScript нет способа объявить статическую функцию в интерфейсе.

Также невозможно получить производное от Observable класса, скажем ExtendedObservable , потому, что каждый пользователь моего кода должен был бы использовать ExtendedObservable тип вместо Observable типа во всем проекте, и концепция дополнительно терпит неудачу, если я хочу использовать разные статические методы для наблюдаемого, в зависимости от импортированных модулей.

Я обнаружил это сам, глядя на реализацию статического .from() расширения в исходном коде RxJS:

 import { myStaticFn as myStaticFnStatic } from "./myStaticFn";

declare module "rxjs/Observable" {
    namespace Observable {
        let myStaticFn: myStaticFnStatic;
    }
}
  

Обратите внимание, как я импортирую myStaticFn , но привязываю его локально к имени myStaticFnStatic — это необходимо, иначе вы получите ошибку компилятора.

В файле определения для rx у вас есть определение для наблюдаемого класса и ObservableStatic .
Если вы хотите добавить статические функции, вам необходимо увеличить ObservableStatic :

 declare module "rxjs/Observable" {
    interface ObservableStatic {
        myOperator: typeof myOperator;
    }
}
  

Вам нужно объявить модуль с тем же именем интерфейса. Внутри модуля вы пишете статические функции. Это лучшая практика в TypeScript. Это называется «слияние модулей».

Ссылка: Страницы Pro TypeScript #40 #41

Только одно замечание: Microsoft изменила термин «внутренний модуль» на «пространство имен» с момента написания этой книги: Пространства имен