@obsidize/command-queue

Index

Enumerations

CommandAbortSignalType

Classes

Interfaces

CommandConfig

Type aliases

CommandAction

Functions

Type aliases

CommandAction

CommandAction<T>: () => ObservableInput<T>

Type parameters

T

Type declaration

- (): ObservableInput<T>
- Alias for an action to be executed via the metadata run function.
  
  Returns ObservableInput<T>

Functions

castAbortSignalStream

castAbortSignalStream<T>(input: Observable<CommandAbortSignalType>): Observable<T>

- Defined in command-abort-signal.ts:45
Utility to convert a normal stream into one that will throw on emission.

Type parameters
- T
Parameters
- input: Observable<CommandAbortSignalType>
Returns Observable<T>

isCommandAbortSignalType

isCommandAbortSignalType(value: any): boolean

- Defined in command-abort-signal.ts:18
Checks if a target value is a valid abort signal type.

Parameters
- value: any
Returns boolean

rxPolyfillLastValueFrom

rxPolyfillLastValueFrom<T>(source: Observable<T>): Promise<T>

- Defined in utility.ts:13
Polyfill for new rxjs lastValueFrom() function since rxjs versions < 7 do not export this.

Type parameters
- T
Parameters
- source: Observable<T>
Returns Promise<T>

rxPolyfillThrowError

rxPolyfillThrowError<T>(error: any): Observable<T>

- Defined in utility.ts:6
Polyfill for old (< rxjs 7) throwError behavior, since rxjs 7+ requires a function instead.

Type parameters
- T
Parameters
- error: any
Returns Observable<T>

throwAbortSignalError

throwAbortSignalError<T>(): OperatorFunction<CommandAbortSignalType, T>

- Defined in command-abort-signal.ts:36
Utility operator to inject an CommandAbortSignalError instance into a stream.

Type parameters
- T
Returns OperatorFunction<CommandAbortSignalType, T>

Generated using TypeDoc