API Reference

ArrayProxyFactoryclass

Creates array proxies that emit index-scoped changes for array mutations.

Overview

Array proxy factory and contracts that emit semantic index/mutation changes.

Quick facts

Kind: class
Module: proxies/array-proxy
Base class: KeyedInstanceFactory< unknown[], IArrayProxyData, IArrayObserverProxyPair, IArrayProxyIdData >
Implements: IArrayProxyFactory
Members: 5
Package: @rs-x/core
Source: proxies/array-proxy/array-proxy.factory.ts

Import

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

Example

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

await InjectionContainer.load(RsXStateManagerModule);

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

Constructor injection example

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

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

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: IArrayProxyIdData): unknown[]

Parameters

Name	Type	Required
data	IArrayProxyIdData	required

Returns

unknown[]

createId

methodprotected

protected override createId(data: IArrayProxyIdData): unknown[]

Parameters

Name	Type	Required
data	IArrayProxyIdData	required

Returns

unknown[]

createInstance

methodprotected

protected override createInstance(
  data: IArrayProxyData,
  id: unknown[]
): IArrayObserverProxyPair

Parameters

Name	Type	Required
data	IArrayProxyData	required
id	unknown[]	required

Returns

IArrayObserverProxyPair

releaseInstance

methodprotected

protected override releaseInstance(
  arrayObserverWithProxy: IArrayObserverProxyPair,
  id: unknown[]
): void

Parameters

Name	Type	Required
arrayObserverWithProxy	IArrayObserverProxyPair	required
id	unknown[]	required

Returns

void