LiveStatus | @m-ld/m-ld-spec

A means to obtain the current status, and await future statuses, of a clone.

Hierarchy

Observable<MeldStatus>
- LiveStatus

Implements

Subscribable<MeldStatus>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new LiveStatus(subscribe?: undefined | ((this: Observable<MeldStatus>, subscriber: Subscriber<MeldStatus>) => TeardownLogic)): LiveStatus

Inherited from LiveStatus.constructor

Parameters
- Optional subscribe: undefined | ((this: Observable<MeldStatus>, subscriber: Subscriber<MeldStatus>) => TeardownLogic)
  
  the function that is called when the Observable is initially subscribed to. This function is given a Subscriber, to which new values can be nexted, or an error method can be called to raise an error, or complete can be called to notify of a successful completion.
Returns LiveStatus

Properties

becomes

becomes: (match?: Partial<MeldStatus>) => Promise<MeldStatus | undefined>

returns: a promise of a future status matching the given partial status (with the exception of the @ticks field, which is ignored if specified). If the clone never achieves the requested status, the promise will resolve to undefined when the clone closes.

Type declaration

- (match?: Partial<MeldStatus>): Promise<MeldStatus | undefined>
- Parameters
  - Optional match: Partial<MeldStatus>
  Returns Promise<MeldStatus | undefined>

operator

operator: Operator<any, MeldStatus> | undefined

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

source

source: Observable<any> | undefined

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

Readonly value

value: MeldStatus

The current clone status

Static create

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

Creates a new Observable by calling the Observable constructor

owner: Observable
method: create
param: the subscriber function to be passed to the Observable constructor
returns: a new observable
nocollapse
deprecated: Use new Observable() instead. Will be removed in v8.

Type declaration

- (...args: any[]): any
- Parameters
  - Rest ...args: any[]
  Returns any

Methods

forEach

forEach(next: (value: MeldStatus) => void): Promise<void>
forEach(next: (value: MeldStatus) => void, promiseCtor: PromiseConstructorLike): Promise<void>

Inherited from LiveStatus.forEach
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 {@link timeout}, {@link take}, {@link takeWhile}, or {@link takeUntil} amongst others.

Example
```
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: MeldStatus) => void
  
  a handler for each value emitted by the observable
  - - (value: MeldStatus): void
    - Parameters
      - value: MeldStatus
      Returns void
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error
Inherited from LiveStatus.forEach

deprecated

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.

Parameters
- next: (value: MeldStatus) => void
  
  a handler for each value emitted by the observable
  - - (value: MeldStatus): void
    - Parameters
      - value: MeldStatus
      Returns void
- 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

lift

lift<R>(operator?: Operator<MeldStatus, R>): Observable<R>

Inherited from LiveStatus.lift

Creates a new Observable, with this Observable instance as the source, and the passed operator defined as the new observable's operator.

method

lift

deprecated

Internal implementation detail, do not use directly. Will be made internal in v8. If you have implemented an operator using lift, it is recommended that you create an operator by simply returning new Observable() directly. See "Creating new operators from scratch" section here: https://rxjs.dev/guide/operators

Type parameters
- R
Parameters
- Optional operator: Operator<MeldStatus, R>
  
  the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

pipe

pipe(): Observable<MeldStatus>
pipe<A>(op1: OperatorFunction<MeldStatus, A>): Observable<A>
pipe<A, B>(op1: OperatorFunction<MeldStatus, A>, op2: OperatorFunction<A, B>): Observable<B>
pipe<A, B, C>(op1: OperatorFunction<MeldStatus, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>): Observable<C>
pipe<A, B, C, D>(op1: OperatorFunction<MeldStatus, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>): Observable<D>
pipe<A, B, C, D, E>(op1: OperatorFunction<MeldStatus, 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<MeldStatus, 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<MeldStatus, 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<MeldStatus, 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<MeldStatus, 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<A, B, C, D, E, F, G, H, I>(op1: OperatorFunction<MeldStatus, 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>[]): Observable<unknown>

Inherited from LiveStatus.pipe

Returns Observable<MeldStatus>
Inherited from LiveStatus.pipe

Type parameters
- A
Parameters
- op1: OperatorFunction<MeldStatus, A>
Returns Observable<A>
Inherited from LiveStatus.pipe

Type parameters
- A
- B
Parameters
- op1: OperatorFunction<MeldStatus, A>
- op2: OperatorFunction<A, B>
Returns Observable<B>
Inherited from LiveStatus.pipe

Type parameters
- A
- B
- C
Parameters
- op1: OperatorFunction<MeldStatus, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
Returns Observable<C>
Inherited from LiveStatus.pipe

Type parameters
- A
- B
- C
- D
Parameters
- op1: OperatorFunction<MeldStatus, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
Returns Observable<D>
Inherited from LiveStatus.pipe

Type parameters
- A
- B
- C
- D
- E
Parameters
- op1: OperatorFunction<MeldStatus, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
- op5: OperatorFunction<D, E>
Returns Observable<E>
Inherited from LiveStatus.pipe

Type parameters
- A
- B
- C
- D
- E
- F
Parameters
- op1: OperatorFunction<MeldStatus, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
- op5: OperatorFunction<D, E>
- op6: OperatorFunction<E, F>
Returns Observable<F>
Inherited from LiveStatus.pipe

Type parameters
- A
- B
- C
- D
- E
- F
- G
Parameters
- op1: OperatorFunction<MeldStatus, 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>
Inherited from LiveStatus.pipe

Type parameters
- A
- B
- C
- D
- E
- F
- G
- H
Parameters
- op1: OperatorFunction<MeldStatus, 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>
Inherited from LiveStatus.pipe

Type parameters
- A
- B
- C
- D
- E
- F
- G
- H
- I
Parameters
- op1: OperatorFunction<MeldStatus, 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>
Inherited from LiveStatus.pipe

Type parameters
- A
- B
- C
- D
- E
- F
- G
- H
- I
Parameters
- op1: OperatorFunction<MeldStatus, 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>
- Rest ...operations: OperatorFunction<any, any>[]
Returns Observable<unknown>

subscribe(observerOrNext?: Partial<Observer<MeldStatus>> | ((value: MeldStatus) => void)): Subscription
subscribe(next?: ((value: MeldStatus) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription

Inherited from LiveStatus.subscribe

Parameters
- Optional observerOrNext: Partial<Observer<MeldStatus>> | ((value: MeldStatus) => void)
Returns Subscription
Inherited from LiveStatus.subscribe

deprecated

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

Parameters
- Optional next: ((value: MeldStatus) => void) | null
- Optional error: ((error: any) => void) | null
- Optional complete: (() => void) | null
Returns Subscription

toPromise

toPromise(): Promise<MeldStatus | undefined>
toPromise(PromiseCtor: typeof Promise): Promise<MeldStatus | undefined>
toPromise(PromiseCtor: PromiseConstructorLike): Promise<MeldStatus | undefined>

Inherited from LiveStatus.toPromise

deprecated

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

Returns Promise<MeldStatus | undefined>
Inherited from LiveStatus.toPromise

deprecated

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

Parameters
- PromiseCtor: typeof Promise
Returns Promise<MeldStatus | undefined>
Inherited from LiveStatus.toPromise

deprecated

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

Parameters
- PromiseCtor: PromiseConstructorLike
Returns Promise<MeldStatus | undefined>

Generated using TypeDoc. Delivered by Vercel. @m-ld/m-ld-spec - v0.7.1-edge.0 Source code licensed MIT. Privacy policy

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional subscribe: undefined | ((this: Observable<MeldStatus>, subscriber: Subscriber<MeldStatus>) => TeardownLogic)

Returns LiveStatus

Properties

becomes

Type declaration

Parameters

Optional match: Partial<MeldStatus>

Returns Promise<MeldStatus | undefined>

operator

source

Readonly value

Static create

Type declaration

Parameters

Rest ...args: any[]

Returns any

Methods

forEach

Example

Parameters

next: (value: MeldStatus) => void

Parameters

value: MeldStatus

Returns void

Returns Promise<void>

Parameters

next: (value: MeldStatus) => void

Parameters

value: MeldStatus

Returns void

promiseCtor: PromiseConstructorLike

Returns Promise<void>

lift

Type parameters

R

Parameters

Optional operator: Operator<MeldStatus, R>

Returns Observable<R>

pipe

Returns Observable<MeldStatus>

Type parameters

A

Parameters

op1: OperatorFunction<MeldStatus, A>

Returns Observable<A>

Type parameters

A

B

Parameters

op1: OperatorFunction<MeldStatus, A>

op2: OperatorFunction<A, B>

Returns Observable<B>

Type parameters

A

B

C

Parameters

op1: OperatorFunction<MeldStatus, A>

op2: OperatorFunction<A, B>

op3: OperatorFunction<B, C>

Returns Observable<C>

Type parameters

A

B

C

D

Parameters

op1: OperatorFunction<MeldStatus, A>

op2: OperatorFunction<A, B>

op3: OperatorFunction<B, C>

op4: OperatorFunction<C, D>