API Reference

MapProxyFactoryclass

Creates map proxies that emit key-scoped changes for set/delete/clear operations.

Overview

Map proxy factory and contracts that emit semantic key/mutation changes.
Quick facts
Kind
class
Module
proxies/map-proxy
Base class
KeyedInstanceFactory< Map<unknown, unknown>, IMapProxifyData, IMapObserverProxyPair >
Implements
IMapProxyFactory
Members
5
Package
@rs-x/core
Source
proxies/map-proxy/map-proxy.factory.ts

Import

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

Example

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

const instance = new MapProxyFactory(...args);

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: IMapProxifyData): Map<unknown, unknown>

Parameters

Name
Type
Required
data
IMapProxifyData
required

Returns

Map<unknown, unknown>

createId
methodprotected
protected override createId(data: IMapProxifyData): Map<unknown, unknown>

Parameters

Name
Type
Required
data
IMapProxifyData
required

Returns

Map<unknown, unknown>

createInstance
methodprotected
protected override createInstance(
  data: IMapProxifyData,
  id: Map<unknown, unknown>
): IMapObserverProxyPair

Parameters

Name
Type
Required
data
IMapProxifyData
required
id
Map<unknown, unknown>
required

Returns

IMapObserverProxyPair

releaseInstance
methodprotected
protected override releaseInstance( mapObserverWithProxy: IMapObserverProxyPair): void

Parameters

Name
Type
Required
mapObserverWithProxy
IMapObserverProxyPair
required

Returns

void