API Reference

SetProxyFactoryclass

Creates set proxies that emit member-scoped changes for add/delete/clear operations.

Overview

Set proxy factory and contracts that emit semantic membership changes.

Quick facts

Kind: class
Module: proxies/set-proxy
Base class: KeyedInstanceFactory< Set<unknown>, ISetProxifyData, ISetObserverProxyPair, ISetProxifyIdData >
Implements: ISetProxyFactory
Members: 5
Package: @rs-x/core
Source: proxies/set-proxy/set-proxy.factory.ts

Import

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

Example

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

await InjectionContainer.load(RsXStateManagerModule);

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

Constructor injection example

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

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

Members

5 members in this class.

constructor

constructorpublic

constructor( @Inject(RsXCoreInjectionTokens.IProxyRegistry) private readonly _proxyRegistry: IProxyRegistry)

Parameters

Name	Type	Required
_proxyRegistry	IProxyRegistry	required

getId

methodpublic

public override getId(data: ISetProxifyIdData): Set<unknown>

Parameters

Name	Type	Required
data	ISetProxifyIdData	required

Returns

Set<unknown>

createId

methodprotected

protected override createId(data: ISetProxifyIdData): Set<unknown>

Parameters

Name	Type	Required
data	ISetProxifyIdData	required

Returns

Set<unknown>

createInstance

methodprotected

protected override createInstance(
  data: ISetProxifyData,
  id: Set<unknown>
): ISetObserverProxyPair

Parameters

Name	Type	Required
data	ISetProxifyData	required
id	Set<unknown>	required

Returns

ISetObserverProxyPair

releaseInstance

methodprotected

protected override releaseInstance( setObserverWithProxy: ISetObserverProxyPair): void

Parameters

Name	Type	Required
setObserverWithProxy	ISetObserverProxyPair	required

Returns

void