API Reference

PromiseProxyFactoryclass

Creates promise observers that emit resolved values through promise-accessor caching.

Overview

Promise proxy factory and change contracts for resolved/rejected transitions.

Quick facts

Kind: class
Module: proxies/promise-proxy
Base class: KeyedInstanceFactory< Promise<unknown>, IPromiseProxyData, IPromiseObserverProxyPair >
Implements: IPromiseProxyFactory
Members: 5
Package: @rs-x/core
Source: proxies/promise-proxy/promise-proxy.factory.ts

Import

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

Example

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

await InjectionContainer.load(RsXStateManagerModule);

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

Constructor injection example

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

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

Members

5 members in this class.

constructor

constructorpublic

constructor(
  @Inject(RsXCoreInjectionTokens.IPromiseAccessor) private readonly _promiseAccessor: IPromiseAccessor
)

Parameters

Name	Type	Required
_promiseAccessor	IPromiseAccessor	required

getId

methodpublic

public override getId(data: IPromiseProxyData): Promise<unknown>

Parameters

Name	Type	Required
data	IPromiseProxyData	required

Returns

Promise<unknown>

createId

methodprotected

protected override createId(data: IPromiseProxyData): Promise<unknown>

Parameters

Name	Type	Required
data	IPromiseProxyData	required

Returns

Promise<unknown>

createInstance

methodprotected

protected override createInstance(
  data: IPromiseProxyData,
  id: Promise<unknown>
): IPromiseObserverProxyPair

Parameters

Name	Type	Required
data	IPromiseProxyData	required
id	Promise<unknown>	required

Returns

IPromiseObserverProxyPair

releaseInstance

methodprotected

protected override releaseInstance( promiseObserverWithProxy: IPromiseObserverProxyPair): void

Parameters

Name	Type	Required
promiseObserverWithProxy	IPromiseObserverProxyPair	required

Returns

void