Class AsyncPipe<T>

An asynchronous version of the Pipe helper.

Type Parameters

T

Hierarchy

AsyncPipe

Index

Constructors

Properties

Methods

peek promise resolve tap then unless when whenNot wrap

Constructors

constructor

new AsyncPipe<T>(subject: AsyncPipeResolver<T>): AsyncPipe<T>
Type Parameters
- T
Parameters
- subject: AsyncPipeResolver<T>
  
  The current value resolver of the pipe.
Returns AsyncPipe<T>
- Defined in src/util/support/Pipe.ts:165

Properties

`Private` subject

subject: AsyncPipeResolver<T>

The current value resolver of the pipe.

Methods

peek

peek<T2>(op: AsyncPipeOperator<T, T2>): AsyncPipe<T>
Apply an operator to the pipe, but return the reference to the current pipe. The operator is resolved when the overall pipe is resolved.
Type Parameters
- T2
Parameters
- op: AsyncPipeOperator<T, T2>
Returns AsyncPipe<T>
- Defined in src/util/support/Pipe.ts:201

promise

promise<T2>(op: PromisePipeOperator<T, T2>): AsyncPipe<T2>
Apply a transformative operator to the pipe, wrapping it in a Promise and passing the resolve/reject callbacks to the closure.
Type Parameters
- T2
Parameters
- op: PromisePipeOperator<T, T2>
Returns AsyncPipe<T2>
- Defined in src/util/support/Pipe.ts:184

resolve

resolve(): Promise<T>
Get the transformed value from the pipe.

Returns Promise<T>
- Defined in src/util/support/Pipe.ts:256

tap

tap<T2>(op: AsyncPipeOperator<T, T2>): AsyncPipe<T2>
Apply a transformative operator to the pipe.
Type Parameters
- T2
Parameters
- op: AsyncPipeOperator<T, T2>
Returns AsyncPipe<T2>
- Defined in src/util/support/Pipe.ts:174

then

then(): Promise<T>
Get the transformed value from the pipe. Allows awaiting the pipe directly.

Returns Promise<T>
- Defined in src/util/support/Pipe.ts:261

unless

unless(check: AsyncPipeCondition<T>, op: ReflexiveAsyncPipeOperator<T>): AsyncPipe<T>
Apply an operator to the pipe, if the check condition fails.
Parameters
- check: AsyncPipeCondition<T>
- op: ReflexiveAsyncPipeOperator<T>
Returns AsyncPipe<T>
- Defined in src/util/support/Pipe.ts:236

when

when(check: AsyncPipeCondition<T>, op: ReflexiveAsyncPipeOperator<T>): AsyncPipe<T>
Apply an operator to the pipe, if the check condition passes.
Parameters
- check: AsyncPipeCondition<T>
- op: ReflexiveAsyncPipeOperator<T>
Returns AsyncPipe<T>
- Defined in src/util/support/Pipe.ts:214

whenNot

whenNot(check: AsyncPipeCondition<T>, op: ReflexiveAsyncPipeOperator<T>): AsyncPipe<T>
Alias of unless().
Parameters
- check: AsyncPipeCondition<T>
- op: ReflexiveAsyncPipeOperator<T>
Returns AsyncPipe<T>
- Defined in src/util/support/Pipe.ts:249

`Static` wrap

wrap<subjectType>(subject: subjectType): AsyncPipe<subjectType>
Get an AsyncPipe with the given value in it.
Type Parameters
- subjectType
Parameters
- subject: subjectType
Returns AsyncPipe<subjectType>
- Defined in src/util/support/Pipe.ts:161