API Reference

StateChangeSubscriptionManagerclass

Maintains grouped observer subscriptions for watched indexes per context.

Overview

Handles grouped observer subscriptions for each watched state key and index-watch-rule variant.
Quick facts
Kind
class
Module
state-manager/state-change-subscription-manager
Base class
KeyedInstanceFactory< unknown, unknown, IStateChangeSubscriptionsForContextManager >
Implements
IStateChangeSubscriptionManager
Members
7
Package
@rs-x/core
Source
state-manager/state-change-subscription-manager/state-change-subsription-manager.ts

Import

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

Example

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

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

Members

7 members in this class.

constructor
constructorpublic
constructor(
  private readonly _objectObserverManager: IObjectPropertyObserverProxyPairManager,
  private readonly _errorLog: IErrorLog,
  private readonly _guidFactory: IGuidFactory
)

Parameters

Name
Type
Required
_objectObserverManager
IObjectPropertyObserverProxyPairManager
required
_errorLog
IErrorLog
required
_guidFactory
IGuidFactory
required
getId
methodpublic
public getId(context: unknown): unknown

Parameters

Name
Type
Required
context
unknown
required

Returns

unknown

instanceGroupInfoEntriesForContext
methodpublic
public instanceGroupInfoEntriesForContext(
  context: unknown
): IterableIterator<IInstanceGroupInfo<string, IObserver>>

Parameters

Name
Type
Required
context
unknown
required

Returns

IterableIterator<IInstanceGroupInfo<string, IObserver>>

isRegistered
methodpublic
public isRegistered(
  context: unknown,
  key: unknown
): boolean

Parameters

Name
Type
Required
context
unknown
required
key
unknown
required

Returns

boolean

createId
methodprotected
protected createId(context: unknown): unknown

Parameters

Name
Type
Required
context
unknown
required

Returns

unknown

createInstance
methodprotected
protected override createInstance(
  context: unknown,
  id: unknown
): IStateChangeSubscriptionsForContextManager

Parameters

Name
Type
Required
context
unknown
required
id
unknown
required

Returns

IStateChangeSubscriptionsForContextManager

releaseInstance
methodprotected
protected override releaseInstance(
  instance: IStateChangeSubscriptionsForContextManager,
  id: unknown
): void

Parameters

Name
Type
Required
instance
IStateChangeSubscriptionsForContextManager
required
id
unknown
required

Returns

void