@types/rx-core

  • Version 4.0.6
  • Published
  • 6.75 kB
  • No dependencies
  • MIT license

Install

npm i @types/rx-core
yarn add @types/rx-core
pnpm add @types/rx-core

Overview

TypeScript definitions for rx-core

Index

Namespaces

namespace Rx

namespace Rx {}

    interface GroupedObservable

    interface GroupedObservable<TKey, TElement> extends Observable<TElement> {}

      property key

      key: TKey;

        property underlyingObservable

        underlyingObservable: Observable<TElement>;

          interface IDisposable

          interface IDisposable {}

            method dispose

            dispose: () => void;

              interface IPromise

              interface IPromise<T> {}
              • Promise A+

              method then

              then: {
              <R>(
              onFulfilled: (value: T) => IPromise<R>,
              onRejected: (reason: any) => IPromise<R>
              ): IPromise<R>;
              <R>(
              onFulfilled: (value: T) => IPromise<R>,
              onRejected?: (reason: any) => R
              ): IPromise<R>;
              <R>(
              onFulfilled: (value: T) => R,
              onRejected: (reason: any) => IPromise<R>
              ): IPromise<R>;
              <R>(
              onFulfilled?: (value: T) => R,
              onRejected?: (reason: any) => R
              ): IPromise<R>;
              };

                interface IScheduler

                interface IScheduler {}

                  method catch

                  catch: (handler: (exception: any) => boolean) => IScheduler;

                    method catchException

                    catchException: (handler: (exception: any) => boolean) => IScheduler;

                      interface Observable

                      interface Observable<T> {}

                        method amb

                        amb: (rightSource: IPromise<T> | Observable<T>) => Observable<T>;

                          method bufferWithCount

                          bufferWithCount: (count: number, skip?: number) => Observable<T[]>;

                            method defaultIfEmpty

                            defaultIfEmpty: (defaultValue?: T) => Observable<T>;

                              method distinct

                              distinct: {
                              (
                              skipParameter: boolean,
                              valueSerializer: (value: T) => string
                              ): Observable<T>;
                              <TKey>(
                              keySelector?: (value: T) => TKey,
                              keySerializer?: (key: TKey) => string
                              ): Observable<T>;
                              };

                                method groupBy

                                groupBy: {
                                <TKey, TElement>(
                                keySelector: (value: T) => TKey,
                                skipElementSelector?: boolean,
                                keySerializer?: (key: TKey) => string
                                ): Observable<GroupedObservable<TKey, T>>;
                                <TKey, TElement>(
                                keySelector: (value: T) => TKey,
                                elementSelector: (value: T) => TElement,
                                keySerializer?: (key: TKey) => string
                                ): Observable<GroupedObservable<TKey, TElement>>;
                                };

                                  method groupByUntil

                                  groupByUntil: {
                                  <TKey, TDuration>(
                                  keySelector: (value: T) => TKey,
                                  skipElementSelector: boolean,
                                  durationSelector: (
                                  group: GroupedObservable<TKey, T>
                                  ) => Observable<TDuration>,
                                  keySerializer?: (key: TKey) => string
                                  ): Observable<GroupedObservable<TKey, T>>;
                                  <TKey, TElement, TDuration>(
                                  keySelector: (value: T) => TKey,
                                  elementSelector: (value: T) => TElement,
                                  durationSelector: (
                                  group: GroupedObservable<TKey, TElement>
                                  ) => Observable<TDuration>,
                                  keySerializer?: (key: TKey) => string
                                  ): Observable<GroupedObservable<TKey, TElement>>;
                                  };

                                    method observeOn

                                    observeOn: (scheduler: IScheduler) => Observable<T>;

                                      method onErrorResumeNext

                                      onErrorResumeNext: (second: IPromise<T> | Observable<T>) => Observable<T>;

                                        method subscribeOn

                                        subscribeOn: (scheduler: IScheduler) => Observable<T>;

                                          method windowWithCount

                                          windowWithCount: (count: number, skip?: number) => Observable<Observable<T>>;

                                            interface ObservableStatic

                                            interface ObservableStatic {}

                                              method amb

                                              amb: {
                                              <T>(...sources: Array<IPromise<T>>): Observable<T>;
                                              <T>(...sources: Observable<T>[]): Observable<T>;
                                              <T>(sources: IPromise<T>[] | Observable<T>[]): Observable<T>;
                                              };

                                                method onErrorResumeNext

                                                onErrorResumeNext: {
                                                <T>(...sources: Array<IPromise<T>>): Observable<T>;
                                                <T>(...sources: Observable<T>[]): Observable<T>;
                                                <T>(sources: IPromise<T>[] | Observable<T>[]): Observable<T>;
                                                };

                                                  method using

                                                  using: <TSource, TResource extends IDisposable>(
                                                  resourceFactory: () => TResource,
                                                  observableFactory: (resource: TResource) => Observable<TSource>
                                                  ) => Observable<TSource>;

                                                    interface Observer

                                                    interface Observer<T> {}

                                                      method checked

                                                      checked: () => Observer<any>;

                                                        interface ObserverStatic

                                                        interface ObserverStatic {}

                                                          method notifyOn

                                                          notifyOn: <T>(scheduler: IScheduler) => Observer<T>;
                                                          • Schedules the invocation of observer methods on the given scheduler.

                                                            Parameter scheduler

                                                            Scheduler to schedule observer messages on.

                                                            Returns

                                                            Observer whose messages are scheduled on the given scheduler.

                                                          namespace rx-core

                                                          module 'rx-core' {}

                                                            interface GroupedObservable

                                                            interface GroupedObservable<TKey, TElement> extends Observable<TElement> {}

                                                              property key

                                                              key: TKey;

                                                                property underlyingObservable

                                                                underlyingObservable: Observable<TElement>;

                                                                  interface IDisposable

                                                                  interface IDisposable {}

                                                                    method dispose

                                                                    dispose: () => void;

                                                                      interface IPromise

                                                                      interface IPromise<T> {}
                                                                      • Promise A+

                                                                      method then

                                                                      then: {
                                                                      <R>(
                                                                      onFulfilled: (value: T) => IPromise<R>,
                                                                      onRejected: (reason: any) => IPromise<R>
                                                                      ): IPromise<R>;
                                                                      <R>(
                                                                      onFulfilled: (value: T) => IPromise<R>,
                                                                      onRejected?: (reason: any) => R
                                                                      ): IPromise<R>;
                                                                      <R>(
                                                                      onFulfilled: (value: T) => R,
                                                                      onRejected: (reason: any) => IPromise<R>
                                                                      ): IPromise<R>;
                                                                      <R>(
                                                                      onFulfilled?: (value: T) => R,
                                                                      onRejected?: (reason: any) => R
                                                                      ): IPromise<R>;
                                                                      };

                                                                        interface IScheduler

                                                                        interface IScheduler {}

                                                                          method catch

                                                                          catch: (handler: (exception: any) => boolean) => IScheduler;

                                                                            method catchException

                                                                            catchException: (handler: (exception: any) => boolean) => IScheduler;

                                                                              interface Observable

                                                                              interface Observable<T> {}

                                                                                method amb

                                                                                amb: (rightSource: IPromise<T> | Observable<T>) => Observable<T>;

                                                                                  method bufferWithCount

                                                                                  bufferWithCount: (count: number, skip?: number) => Observable<T[]>;

                                                                                    method defaultIfEmpty

                                                                                    defaultIfEmpty: (defaultValue?: T) => Observable<T>;

                                                                                      method distinct

                                                                                      distinct: {
                                                                                      (
                                                                                      skipParameter: boolean,
                                                                                      valueSerializer: (value: T) => string
                                                                                      ): Observable<T>;
                                                                                      <TKey>(
                                                                                      keySelector?: (value: T) => TKey,
                                                                                      keySerializer?: (key: TKey) => string
                                                                                      ): Observable<T>;
                                                                                      };

                                                                                        method groupBy

                                                                                        groupBy: {
                                                                                        <TKey, TElement>(
                                                                                        keySelector: (value: T) => TKey,
                                                                                        skipElementSelector?: boolean,
                                                                                        keySerializer?: (key: TKey) => string
                                                                                        ): Observable<GroupedObservable<TKey, T>>;
                                                                                        <TKey, TElement>(
                                                                                        keySelector: (value: T) => TKey,
                                                                                        elementSelector: (value: T) => TElement,
                                                                                        keySerializer?: (key: TKey) => string
                                                                                        ): Observable<GroupedObservable<TKey, TElement>>;
                                                                                        };

                                                                                          method groupByUntil

                                                                                          groupByUntil: {
                                                                                          <TKey, TDuration>(
                                                                                          keySelector: (value: T) => TKey,
                                                                                          skipElementSelector: boolean,
                                                                                          durationSelector: (
                                                                                          group: GroupedObservable<TKey, T>
                                                                                          ) => Observable<TDuration>,
                                                                                          keySerializer?: (key: TKey) => string
                                                                                          ): Observable<GroupedObservable<TKey, T>>;
                                                                                          <TKey, TElement, TDuration>(
                                                                                          keySelector: (value: T) => TKey,
                                                                                          elementSelector: (value: T) => TElement,
                                                                                          durationSelector: (
                                                                                          group: GroupedObservable<TKey, TElement>
                                                                                          ) => Observable<TDuration>,
                                                                                          keySerializer?: (key: TKey) => string
                                                                                          ): Observable<GroupedObservable<TKey, TElement>>;
                                                                                          };

                                                                                            method observeOn

                                                                                            observeOn: (scheduler: IScheduler) => Observable<T>;

                                                                                              method onErrorResumeNext

                                                                                              onErrorResumeNext: (second: IPromise<T> | Observable<T>) => Observable<T>;

                                                                                                method subscribeOn

                                                                                                subscribeOn: (scheduler: IScheduler) => Observable<T>;

                                                                                                  method windowWithCount

                                                                                                  windowWithCount: (count: number, skip?: number) => Observable<Observable<T>>;

                                                                                                    interface ObservableStatic

                                                                                                    interface ObservableStatic {}

                                                                                                      method amb

                                                                                                      amb: {
                                                                                                      <T>(...sources: Array<IPromise<T>>): Observable<T>;
                                                                                                      <T>(...sources: Observable<T>[]): Observable<T>;
                                                                                                      <T>(sources: IPromise<T>[] | Observable<T>[]): Observable<T>;
                                                                                                      };

                                                                                                        method onErrorResumeNext

                                                                                                        onErrorResumeNext: {
                                                                                                        <T>(...sources: Array<IPromise<T>>): Observable<T>;
                                                                                                        <T>(...sources: Observable<T>[]): Observable<T>;
                                                                                                        <T>(sources: IPromise<T>[] | Observable<T>[]): Observable<T>;
                                                                                                        };

                                                                                                          method using

                                                                                                          using: <TSource, TResource extends IDisposable>(
                                                                                                          resourceFactory: () => TResource,
                                                                                                          observableFactory: (resource: TResource) => Observable<TSource>
                                                                                                          ) => Observable<TSource>;

                                                                                                            interface Observer

                                                                                                            interface Observer<T> {}

                                                                                                              method checked

                                                                                                              checked: () => Observer<any>;

                                                                                                                interface ObserverStatic

                                                                                                                interface ObserverStatic {}

                                                                                                                  method notifyOn

                                                                                                                  notifyOn: <T>(scheduler: IScheduler) => Observer<T>;
                                                                                                                  • Schedules the invocation of observer methods on the given scheduler.

                                                                                                                    Parameter scheduler

                                                                                                                    Scheduler to schedule observer messages on.

                                                                                                                    Returns

                                                                                                                    Observer whose messages are scheduled on the given scheduler.

                                                                                                                  Package Files (1)

                                                                                                                  Dependencies (0)

                                                                                                                  No dependencies.

                                                                                                                  Dev Dependencies (0)

                                                                                                                  No dev dependencies.

                                                                                                                  Peer Dependencies (0)

                                                                                                                  No peer dependencies.

                                                                                                                  Badge

                                                                                                                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/rx-core.

                                                                                                                  • Markdown
                                                                                                                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/rx-core)
                                                                                                                  • HTML
                                                                                                                    <a href="https://www.jsdocs.io/package/@types/rx-core"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>