@craftworks/rxjs-utils

A RxJS library that provides useful general-purpose functionalities.

Installation

npm install --save @craftworks/rxjs-utils

Check for necessary peer dependencies.

Peer Dependencies

• rxjs: ^6.6.3 || ^7.0.0

API

/**
 * Logs the current value to the console on .next, .error and .complete
 *
 * @param {string} [tag] - A tag, if no tag is supplied a incrementing index is used
 */
function debug<T>(tag?: string | undefined): MonoTypeOperatorFunction<T>

/**
 * Sets the status of the loadingStore$ to true
 * Use this when loading should be started
 * @param loadingStore$  - Store to set `isLoading` state
 * @param [omitError] - Whether to set loadingStore and loadedStore when an error occurs
 * @returns An Observable identical to the source, but runs the specified Observer or callback(s) for each item
 */
function loadingStart<T>(loadingStore$: Subject<boolean>, omitError = false): MonoTypeOperatorFunction<T>;

/**
 * Sets the status of the loadingStore$ to false
 * Use this when loading should be stopped
 * @param loadingStore$  - Store to set `isLoading` state
 * @param [loadedStore$] - Store to set `hasLoaded` state
 * @param [omitError] - Whether to set loadingStore and loadedStore when an error occurs
 * @returns An observable identical to the source, but runs the action for each item
 */
function loadingStop<T>(loadingStore$: Subject<boolean>, loadedStore$?: Subject<boolean>, omitError = false): MonoTypeOperatorFunction<T>;

/**
 * Sets the status of the loadingStore$ to true on every individual subscription
 * Use this when loading should be started at subscription
 * @param loadingStore$ - Store to set `isLoading` state
 * @returns An observable identical to the source, but runs the action for each item
 */
function loadingStartDefer<T>(loadingStore$: Subject<boolean>): MonoTypeOperatorFunction<T>

/**
 * Sets the status of the loadingStore$ to true via an imperative call
 * Use this when loading should be stopped in an imperative manner (e.g. before calling a observable)
 * @param loadingStore$  - Store to set `isLoading` state
 */
function loadingStartStatic(loadingStore$: Subject<boolean>): void;

/**
 * Sets the status of the loadingStore$ to false via an imperative call
 * Use this when loading should be stopped in an imperative manner (e.g. externally stopping)
 * @param loadingStore$  - Store to set `isLoading` state
 * @param [loadedStore$] - Store to set `hasLoaded` state
 */
function loadingStopStatic(loadingStore$: Subject<boolean>, loadedStore$?: Subject<boolean>): void;

Change Log

See CHANGELOG.md

License

MIT