Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ObservableList<TData>

Creates an observable list (or detail) from a promise-callback.

Type parameters

  • TData

Hierarchy

  • Observable<TData>
    • ObservableList

Implements

  • Subscribable<TData>

Index

Constructors

constructor

  • Creates a observable list with optional paging and realtime configuration.

    Parameters

    • request: function

      List (or detail) from a promise-callback

    • Optional realtime$: Observable<TData>

      Observable realtime object (optional)

    • Default value options: IObservableOptions = {}

      The observable configuration

    • Default value realtimeFilter: any = {}

    Returns ObservableList

Properties

_isScalar

_isScalar: boolean

Internal implementation detail, do not use directly.

operator

operator: Operator<any, TData>
deprecated

This is an internal implementation detail, do not use.

source

source: Observable<any>
deprecated

This is an internal implementation detail, do not use.

Static create

create: Function

Creates a new cold Observable by calling the Observable constructor

static

true

owner

Observable

method

create

param

the subscriber function to be passed to the Observable constructor

returns

a new cold observable

nocollapse

Static if

if: iif
nocollapse
deprecated

In favor of iif creation function: import { iif } from 'rxjs';

Static throw

throw: throwError
nocollapse
deprecated

In favor of throwError creation function: import { throwError } from 'rxjs';

Methods

_subscribe

  • _subscribe(subscriber: Subscriber<any>): TeardownLogic
  • deprecated

    This is an internal implementation detail, do not use.

    Parameters

    • subscriber: Subscriber<any>

    Returns TeardownLogic

_trySubscribe

  • _trySubscribe(sink: Subscriber<TData>): TeardownLogic
  • deprecated

    This is an internal implementation detail, do not use.

    Parameters

    • sink: Subscriber<TData>

    Returns TeardownLogic

compose

  • compose(request: function, pagingStrategy?: PagingStrategy, pagingDelay?: number): Observable<any>
  • Creates a observable with the given paging strategy.

    Parameters

    • request: function

      List (or detail) from a promise-callback

    • Default value pagingStrategy: PagingStrategy = PagingStrategy.ALL

      The paging strategy to use.

    • Default value pagingDelay: number = 0

      If all pages are loaded, the paging is delayed by x ms.

    Returns Observable<any>

composeDetail

  • composeDetail(): Observable<any>
  • Returns Observable<any>

composeHot

  • composeHot(): Observable<any>
  • Returns Observable<any>

composeRealtime

  • composeRealtime(realtime$: Observable<TData>, action?: RealtimeAction): any
  • Parameters

    • realtime$: Observable<TData>
    • Default value action: RealtimeAction = RealtimeAction.FULL

    Returns any

forEach

  • forEach(next: function, promiseCtor?: PromiseConstructorLike): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: TData): void
        • Parameters

          • value: TData

          Returns void

    • Optional promiseCtor: PromiseConstructorLike

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • lift<R>(operator: Operator<TData, R>): Observable<R>
  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<TData, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

more

  • more(): any
  • Load more data from this service (next page).

    Returns any

pipe

  • pipe(): Observable<TData>
  • pipe<A>(op1: OperatorFunction<TData, A>): Observable<A>
  • pipe<A, B>(op1: OperatorFunction<TData, A>, op2: OperatorFunction<A, B>): Observable<B>
  • pipe<A, B, C>(op1: OperatorFunction<TData, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>): Observable<C>
  • pipe<A, B, C, D>(op1: OperatorFunction<TData, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>): Observable<D>
  • pipe<A, B, C, D, E>(op1: OperatorFunction<TData, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>): Observable<E>
  • pipe<A, B, C, D, E, F>(op1: OperatorFunction<TData, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>): Observable<F>
  • pipe<A, B, C, D, E, F, G>(op1: OperatorFunction<TData, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>, op7: OperatorFunction<F, G>): Observable<G>
  • pipe<A, B, C, D, E, F, G, H>(op1: OperatorFunction<TData, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>, op7: OperatorFunction<F, G>, op8: OperatorFunction<G, H>): Observable<H>
  • pipe<A, B, C, D, E, F, G, H, I>(op1: OperatorFunction<TData, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>, op7: OperatorFunction<F, G>, op8: OperatorFunction<G, H>, op9: OperatorFunction<H, I>): Observable<I>
  • pipe<R>(...operations: OperatorFunction<TData, R>[]): Observable<R>
  • Returns Observable<TData>

  • Type parameters

    • A

    Parameters

    • op1: OperatorFunction<TData, A>

    Returns Observable<A>

  • Type parameters

    • A

    • B

    Parameters

    • op1: OperatorFunction<TData, A>
    • op2: OperatorFunction<A, B>

    Returns Observable<B>

  • Type parameters

    • A

    • B

    • C

    Parameters

    • op1: OperatorFunction<TData, A>
    • op2: OperatorFunction<A, B>
    • op3: OperatorFunction<B, C>

    Returns Observable<C>

  • Type parameters

    • A

    • B

    • C

    • D

    Parameters

    • op1: OperatorFunction<TData, A>
    • op2: OperatorFunction<A, B>
    • op3: OperatorFunction<B, C>
    • op4: OperatorFunction<C, D>

    Returns Observable<D>

  • Type parameters

    • A

    • B

    • C

    • D

    • E

    Parameters

    • op1: OperatorFunction<TData, A>
    • op2: OperatorFunction<A, B>
    • op3: OperatorFunction<B, C>
    • op4: OperatorFunction<C, D>
    • op5: OperatorFunction<D, E>

    Returns Observable<E>

  • Type parameters

    • A

    • B

    • C

    • D

    • E

    • F

    Parameters

    • op1: OperatorFunction<TData, A>
    • op2: OperatorFunction<A, B>
    • op3: OperatorFunction<B, C>
    • op4: OperatorFunction<C, D>
    • op5: OperatorFunction<D, E>
    • op6: OperatorFunction<E, F>

    Returns Observable<F>

  • Type parameters

    • A

    • B

    • C

    • D

    • E

    • F

    • G

    Parameters

    • op1: OperatorFunction<TData, A>
    • op2: OperatorFunction<A, B>
    • op3: OperatorFunction<B, C>
    • op4: OperatorFunction<C, D>
    • op5: OperatorFunction<D, E>
    • op6: OperatorFunction<E, F>
    • op7: OperatorFunction<F, G>

    Returns Observable<G>

  • Type parameters

    • A

    • B

    • C

    • D

    • E

    • F

    • G

    • H

    Parameters

    • op1: OperatorFunction<TData, A>
    • op2: OperatorFunction<A, B>
    • op3: OperatorFunction<B, C>
    • op4: OperatorFunction<C, D>
    • op5: OperatorFunction<D, E>
    • op6: OperatorFunction<E, F>
    • op7: OperatorFunction<F, G>
    • op8: OperatorFunction<G, H>

    Returns Observable<H>

  • Type parameters

    • A

    • B

    • C

    • D

    • E

    • F

    • G

    • H

    • I

    Parameters

    • op1: OperatorFunction<TData, A>
    • op2: OperatorFunction<A, B>
    • op3: OperatorFunction<B, C>
    • op4: OperatorFunction<C, D>
    • op5: OperatorFunction<D, E>
    • op6: OperatorFunction<E, F>
    • op7: OperatorFunction<F, G>
    • op8: OperatorFunction<G, H>
    • op9: OperatorFunction<H, I>

    Returns Observable<I>

  • Type parameters

    • R

    Parameters

    • Rest ...operations: OperatorFunction<TData, R>[]

    Returns Observable<R>

subscribe

  • subscribe(observer?: PartialObserver<TData>): Subscription
  • subscribe(next?: function, error?: function, complete?: function): Subscription
  • Parameters

    • Optional observer: PartialObserver<TData>

    Returns Subscription

  • Parameters

    • Optional next: function
        • (value: TData): void
        • Parameters

          • value: TData

          Returns void

    • Optional error: function
        • (error: any): void
        • Parameters

          • error: any

          Returns void

    • Optional complete: function
        • (): void
        • Returns void

    Returns Subscription

toPromise

  • toPromise<T>(this: Observable<T>): Promise<T>
  • toPromise<T>(this: Observable<T>, PromiseCtor: PromiseConstructor): Promise<T>
  • toPromise<T>(this: Observable<T>, PromiseCtor: PromiseConstructorLike): Promise<T>
  • Type parameters

    • T

    Parameters

    • this: Observable<T>

    Returns Promise<T>

  • Type parameters

    • T

    Parameters

    • this: Observable<T>
    • PromiseCtor: PromiseConstructor

    Returns Promise<T>

  • Type parameters

    • T

    Parameters

    • this: Observable<T>
    • PromiseCtor: PromiseConstructorLike

    Returns Promise<T>

Generated using TypeDoc