Class DocumentStore

Hierarchy (View Summary)

Constructors

Properties

_delay: number
_fields: any
_incremental: boolean = false
_model: Model<any>
_paging: any
_populates: any[]
_query: any
_sort: any
_subscription: Subscription
_subscriptionDiffs: Map<string, boolean>
_subscriptionId: string
_target: string
_type: EStoreType
_virtuals: any[]
closed: boolean
hasError: boolean

Internal implementation detail, do not use directly. Will be made internal in v8.

isStopped: boolean

Internal implementation detail, do not use directly. Will be made internal in v8.

observers: Observer<any>[]

Internal implementation detail, do not use directly. Will be made internal in v8.

operator: Operator<any, any>

Internal implementation detail, do not use directly. Will be made internal in v8.

source: Observable<any>

Internal implementation detail, do not use directly. Will be made internal in v8.

thrownError: any

Internal implementation detail, do not use directly. Will be made internal in v8.

create: (...args: any[]) => any

Creates a "subject" by basically gluing an observer to an observable.

Recommended you do not use. Will be removed at some point in the future. Plans for replacement still under discussion.

Accessors

  • get observed(): boolean

    Returns boolean

  • set subscription(subscription: Subscription): void

    Parameters

    • subscription: Subscription

    Returns void

Methods

  • Creates a new Observable with this Subject as the source. You can do this to create custom Observer-side logic of the Subject and conceal it from code that uses the Observable.

    Returns Observable<any>

    Observable that this Subject casts to.

  • Returns void

  • Parameters

    • startTime: number
    • subscriptionId: string
    • deleted: any

    Returns void

  • Parameters

    • startTime: number
    • subscriptionId: string
    • error: any

    Returns void

  • Parameters

    • startTime: number
    • subscriptionId: string
    • update: any = ...

    Returns void

  • Parameters

    • startTime: number
    • subscriptionId: string
    • update: any = {}

    Returns void

  • Parameters

    • startTime: number
    • subscriptionId: string
    • total: any

    Returns void

  • Parameters

    • err: any

    Returns void

  • Used as a NON-CANCELLABLE means of subscribing to an observable, for use with APIs that expect promises, like async/await. You cannot unsubscribe from this.

    WARNING: Only use this with observables you know will complete. If the source observable does not complete, you will end up with a promise that is hung up, and potentially all of the state of an async function hanging out in memory. To avoid this situation, look into adding something like timeout, take, takeWhile, or takeUntil amongst others.

    import { interval, take } from 'rxjs';

    const source$ = interval(1000).pipe(take(4));

    async function getTotal() {
    let total = 0;

    await source$.forEach(value => {
    total += value;
    console.log('observable -> ' + value);
    });

    return total;
    }

    getTotal().then(
    total => console.log('Total: ' + total)
    );

    // Expected:
    // 'observable -> 0'
    // 'observable -> 1'
    // 'observable -> 2'
    // 'observable -> 3'
    // 'Total: 6'

    Parameters

    • next: (value: any) => void

      A handler for each value emitted by the observable.

    Returns Promise<void>

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

  • Parameters

    • next: (value: any) => void

      a handler for each value emitted by the observable

    • promiseCtor: PromiseConstructorLike

      a constructor function used to instantiate the Promise

    Returns Promise<void>

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

    Passing a Promise constructor will no longer be available in upcoming versions of RxJS. This is because it adds weight to the library, for very little benefit. If you need this functionality, it is recommended that you either polyfill Promise, or you create an adapter to convert the returned native promise to whatever promise implementation you wanted. Will be removed in v8.

  • Type Parameters

    • R

    Parameters

    • operator: Operator<any, R>

    Returns Observable<R>

    Internal implementation detail, do not use directly. Will be made internal in v8.

  • Parameters

    • value: any

    Returns void

  • Returns Observable<any>

  • Type Parameters

    • A

    Parameters

    • op1: OperatorFunction<any, A>

    Returns Observable<A>

  • Type Parameters

    • A
    • B

    Parameters

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

    Returns Observable<B>

  • Type Parameters

    • A
    • B
    • C

    Parameters

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

    Returns Observable<C>

  • Type Parameters

    • A
    • B
    • C
    • D

    Parameters

    • op1: OperatorFunction<any, 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<any, 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<any, 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<any, 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<any, 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<any, 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

    • A
    • B
    • C
    • D
    • E
    • F
    • G
    • H
    • I

    Parameters

    • op1: OperatorFunction<any, 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>
    • ...operations: OperatorFunction<any, any>[]

    Returns Observable<unknown>

  • Parameters

    • OptionalobserverOrNext: Partial<Observer<any>> | (value: any) => void

    Returns Subscription

  • Parameters

    • Optionalnext: (value: any) => void
    • Optionalerror: (error: any) => void
    • Optionalcomplete: () => void

    Returns Subscription

    Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments

  • Returns Promise<any>

    Replaced with firstValueFrom and lastValueFrom. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise

  • Parameters

    • PromiseCtor: PromiseConstructor

    Returns Promise<any>

    Replaced with firstValueFrom and lastValueFrom. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise

  • Parameters

    • PromiseCtor: PromiseConstructorLike

    Returns Promise<any>

    Replaced with firstValueFrom and lastValueFrom. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise

  • Returns void