@rxjs-ninja/rxjs-utility/lib/rgb-to-hex.d.ts

Useful utilities for RxJS

/**
 * @packageDocumentation
 * @module Colour
 */
import { MonoTypeOperatorFunction, Subscribable } from 'rxjs';
/**
 * Returns an Observable that emits a string containing a HTML hex colour converted from a source rgb string
 *
 * @category Colour
 *
 * @param excludeHash Optional boolean to exclude the hash (`#`) character from the return result
 *
 * @example
 * Returns hex results from rgb colour strings
 * ```ts
 * const input = ['rgb(0,0,0)', 'rgb(255,255,255)', 'rgb(0,255,0)'];
 * from(input).pipe(rgbToHex()).subscribe();
 * ```
 * Output: `'#000000', '#ffffff', '#00ff00'`
 *
 * @example
 * Returns hex results from rgb colour strings excluding hash
 * ```ts
 * const input = ['rgb(0,0,0)', 'rgb(255,255,255)', 'rgb(0,255,0)'];
 * from(input).pipe(rgbToHex(true)).subscribe();
 * ```
 * Output: `'000000', 'ffffff', '00ff00'`
 *
 * @returns Observable that emits a string containing a HTML hex colour
 */
export declare function rgbToHex(excludeHash?: Subscribable<boolean> | boolean): MonoTypeOperatorFunction<string>;