Elgato_dark/angular
1
0
Fork 0
mirror of https://github.com/angular/angular synced 2026-05-24 09:28:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
angular/goldens/public-api/core/rxjs-interop/index.api.md
Alex Rickabaugh 4bcf1831d9 refactor(core): rename loader parameter to stream for rxResource (#60919) 
As decided in the Resource RFC, this commit renames `loader` in `rxResource`
to `stream`. Some logic is left in to support gradual rollout of this change
in g3.

PR Close #60919
2025-04-23 19:34:50 +00:00

2.5 KiB
Raw Blame History

API Report File for "@angular/core_rxjs-interop"

Do not edit this file. It is a report generated by API Extractor.


import { MonoTypeOperatorFunction } from 'rxjs';
import { Observable } from 'rxjs';
import { Subscribable } from 'rxjs';

// @public
export function outputFromObservable<T>(observable: Observable<T>, opts?: OutputOptions): OutputRef<T>;

// @public
export function outputToObservable<T>(ref: OutputRef<T>): Observable<T>;

// @public
export function pendingUntilEvent<T>(injector?: Injector): MonoTypeOperatorFunction<T>;

// @public
export function rxResource<T, R>(opts: RxResourceOptions<T, R> & {
    defaultValue: NoInfer<T>;
}): ResourceRef<T>;

// @public
export function rxResource<T, R>(opts: RxResourceOptions<T, R>): ResourceRef<T | undefined>;

// @public
export interface RxResourceOptions<T, R> extends BaseResourceOptions<T, R> {
    // (undocumented)
    stream: (params: ResourceLoaderParams<R>) => Observable<T>;
}

// @public
export function takeUntilDestroyed<T>(destroyRef?: DestroyRef): MonoTypeOperatorFunction<T>;

// @public
export function toObservable<T>(source: Signal<T>, options?: ToObservableOptions): Observable<T>;

// @public
export interface ToObservableOptions {
    injector?: Injector;
}

// @public (undocumented)
export function toSignal<T>(source: Observable<T> | Subscribable<T>): Signal<T | undefined>;

// @public (undocumented)
export function toSignal<T>(source: Observable<T> | Subscribable<T>, options: NoInfer<ToSignalOptions<T | undefined>> & {
    initialValue?: undefined;
    requireSync?: false;
}): Signal<T | undefined>;

// @public (undocumented)
export function toSignal<T>(source: Observable<T> | Subscribable<T>, options: NoInfer<ToSignalOptions<T | null>> & {
    initialValue?: null;
    requireSync?: false;
}): Signal<T | null>;

// @public (undocumented)
export function toSignal<T>(source: Observable<T> | Subscribable<T>, options: NoInfer<ToSignalOptions<T>> & {
    initialValue?: undefined;
    requireSync: true;
}): Signal<T>;

// @public (undocumented)
export function toSignal<T, const U extends T>(source: Observable<T> | Subscribable<T>, options: NoInfer<ToSignalOptions<T | U>> & {
    initialValue: U;
    requireSync?: false;
}): Signal<T | U>;

// @public
export interface ToSignalOptions<T> {
    equal?: ValueEqualityFn_2<T>;
    initialValue?: unknown;
    injector?: Injector;
    manualCleanup?: boolean;
    requireSync?: boolean;
}

// (No @packageDocumentation comment for this package)