diff options
| author | Pinapelz <yukais@pinapelz.com> | 2025-06-28 17:26:46 -0700 |
|---|---|---|
| committer | Pinapelz <yukais@pinapelz.com> | 2025-06-28 17:43:56 -0700 |
| commit | e4fa1e69e7ebfb627c7198fd1a9881e9327ec4d4 (patch) | |
| tree | 06284a538a6008eca75051399e47db4e5d50301c /node_modules/rxjs/src/internal/operators/mapTo.ts | |
initial commit: scaffolding
Diffstat (limited to 'node_modules/rxjs/src/internal/operators/mapTo.ts')
| -rw-r--r-- | node_modules/rxjs/src/internal/operators/mapTo.ts | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/node_modules/rxjs/src/internal/operators/mapTo.ts b/node_modules/rxjs/src/internal/operators/mapTo.ts new file mode 100644 index 0000000..9fb8a8e --- /dev/null +++ b/node_modules/rxjs/src/internal/operators/mapTo.ts @@ -0,0 +1,48 @@ +import { OperatorFunction } from '../types'; +import { map } from './map'; + +/** @deprecated To be removed in v9. Use {@link map} instead: `map(() => value)`. */ +export function mapTo<R>(value: R): OperatorFunction<unknown, R>; +/** + * @deprecated Do not specify explicit type parameters. Signatures with type parameters + * that cannot be inferred will be removed in v8. `mapTo` itself will be removed in v9, + * use {@link map} instead: `map(() => value)`. + * */ +export function mapTo<T, R>(value: R): OperatorFunction<T, R>; + +/** + * Emits the given constant value on the output Observable every time the source + * Observable emits a value. + * + * <span class="informal">Like {@link map}, but it maps every source value to + * the same output value every time.</span> + * + *  + * + * Takes a constant `value` as argument, and emits that whenever the source + * Observable emits a value. In other words, ignores the actual source value, + * and simply uses the emission moment to know when to emit the given `value`. + * + * ## Example + * + * Map every click to the string `'Hi'` + * + * ```ts + * import { fromEvent, mapTo } from 'rxjs'; + * + * const clicks = fromEvent(document, 'click'); + * const greetings = clicks.pipe(mapTo('Hi')); + * + * greetings.subscribe(x => console.log(x)); + * ``` + * + * @see {@link map} + * + * @param value The value to map each source value to. + * @return A function that returns an Observable that emits the given `value` + * every time the source Observable emits. + * @deprecated To be removed in v9. Use {@link map} instead: `map(() => value)`. + */ +export function mapTo<R>(value: R): OperatorFunction<unknown, R> { + return map(() => value); +} |
