API Reference

ObservableProxyFactoryclass

Creates observable observers that emit distinct latest values through observable-accessor caching.

Overview

Observable proxy factory and change contracts for emitted value transitions.

Quick facts

Kind: class
Module: proxies/observable-proxy
Base class: KeyedInstanceFactory< Observable<unknown>, IObservableProxyData, IObservableObserverProxyPair >
Implements: IObservableProxyFactory
Members: 5
Package: @rs-x/core
Source: proxies/observable-proxy/observable-proxy.factory.ts

Import

import { ObservableProxyFactory } from '@rs-x/state-manager';

Example

import { InjectionContainer } from '@rs-x/core';
import {
  RsXStateManagerInjectionTokens,
  RsXStateManagerModule,
  type IObservableProxyFactory,
} from '@rs-x/state-manager';

await InjectionContainer.load(RsXStateManagerModule);

// Resolve from DI container (do not construct this service directly).
const observableProxy = InjectionContainer.get<IObservableProxyFactory>(
  RsXStateManagerInjectionTokens.IObservableProxyFactory,
);
console.log(observableProxy);

Constructor injection example

import { Inject } from '@rs-x/core';
import {
  RsXStateManagerInjectionTokens,
  type IObservableProxyFactory,
} from '@rs-x/state-manager';

class MyConsumer {
  constructor(
    @Inject(RsXStateManagerInjectionTokens.IObservableProxyFactory)
    private readonly dependency: IObservableProxyFactory,
  ) {}
}

Members

5 members in this class.

constructor

constructorpublic

constructor(
  @Inject(RsXCoreInjectionTokens.IObservableAccessor) private readonly _observableAccessor: IObservableAccessor
)

Parameters

Name	Type	Required
_observableAccessor	IObservableAccessor	required

getId

methodpublic

public override getId(data: IObservableProxyData): Observable<unknown>

Parameters

Name	Type	Required
data	IObservableProxyData	required

Returns

Observable<unknown>

createId

methodprotected

protected override createId(data: IObservableProxyData): Observable<unknown>

Parameters

Name	Type	Required
data	IObservableProxyData	required

Returns

Observable<unknown>

createInstance

methodprotected

protected override createInstance(
  data: IObservableProxyData,
  id: Observable<unknown>
): IObservableObserverProxyPair

Parameters

Name	Type	Required
data	IObservableProxyData	required
id	Observable<unknown>	required

Returns

IObservableObserverProxyPair

releaseInstance

methodprotected

protected override releaseInstance( observableObserverWithProxy: IObservableObserverProxyPair): void

Parameters

Name	Type	Required
observableObserverWithProxy	IObservableObserverProxyPair	required

Returns

void