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/observable/pairs.ts | |
initial commit: scaffolding
Diffstat (limited to 'node_modules/rxjs/src/internal/observable/pairs.ts')
| -rw-r--r-- | node_modules/rxjs/src/internal/observable/pairs.ts | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/node_modules/rxjs/src/internal/observable/pairs.ts b/node_modules/rxjs/src/internal/observable/pairs.ts new file mode 100644 index 0000000..ca4d7f0 --- /dev/null +++ b/node_modules/rxjs/src/internal/observable/pairs.ts @@ -0,0 +1,80 @@ +import { Observable } from '../Observable'; +import { SchedulerLike } from '../types'; +import { from } from './from'; + +/** + * @deprecated Use `from(Object.entries(obj))` instead. Will be removed in v8. + */ +export function pairs<T>(arr: readonly T[], scheduler?: SchedulerLike): Observable<[string, T]>; +/** + * @deprecated Use `from(Object.entries(obj))` instead. Will be removed in v8. + */ +export function pairs<O extends Record<string, unknown>>(obj: O, scheduler?: SchedulerLike): Observable<[keyof O, O[keyof O]]>; +/** + * @deprecated Use `from(Object.entries(obj))` instead. Will be removed in v8. + */ +export function pairs<T>(iterable: Iterable<T>, scheduler?: SchedulerLike): Observable<[string, T]>; +/** + * @deprecated Use `from(Object.entries(obj))` instead. Will be removed in v8. + */ +export function pairs( + n: number | bigint | boolean | ((...args: any[]) => any) | symbol, + scheduler?: SchedulerLike +): Observable<[never, never]>; + +/** + * Convert an object into an Observable of `[key, value]` pairs. + * + * <span class="informal">Turn entries of an object into a stream.</span> + * + *  + * + * `pairs` takes an arbitrary object and returns an Observable that emits arrays. Each + * emitted array has exactly two elements - the first is a key from the object + * and the second is a value corresponding to that key. Keys are extracted from + * an object via `Object.keys` function, which means that they will be only + * enumerable keys that are present on an object directly - not ones inherited + * via prototype chain. + * + * By default, these arrays are emitted synchronously. To change that you can + * pass a {@link SchedulerLike} as a second argument to `pairs`. + * + * ## Example + * + * Converts an object to an Observable + * + * ```ts + * import { pairs } from 'rxjs'; + * + * const obj = { + * foo: 42, + * bar: 56, + * baz: 78 + * }; + * + * pairs(obj).subscribe({ + * next: value => console.log(value), + * complete: () => console.log('Complete!') + * }); + * + * // Logs: + * // ['foo', 42] + * // ['bar', 56] + * // ['baz', 78] + * // 'Complete!' + * ``` + * + * ### Object.entries required + * + * In IE, you will need to polyfill `Object.entries` in order to use this. + * [MDN has a polyfill here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/entries) + * + * @param obj The object to inspect and turn into an Observable sequence. + * @param scheduler An optional IScheduler to schedule when resulting + * Observable will emit values. + * @returns An observable sequence of [key, value] pairs from the object. + * @deprecated Use `from(Object.entries(obj))` instead. Will be removed in v8. + */ +export function pairs(obj: any, scheduler?: SchedulerLike) { + return from(Object.entries(obj), scheduler as any); +} |
