API Reference

ObserverGroupclass

Composes multiple observers and emits a single unified change stream.

Overview

Observer grouping contracts and helper types.
Quick facts
Kind
class
Members
8
Package
@rs-x/core

Import

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

Example

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

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

Members

8 members in this class.

constructor
constructorpublic
constructor(
  owner: IDisposableOwner | undefined,
  target: unknown,
  initialValue: unknown,
  mustHandleChange: ((change: IPropertyChange) => boolean) | undefined,
  private readonly _errorLog: IErrorLog,
  id?: unknown,
  private readonly getRootObserver?: () => IObserver | undefined,
  private readonly _observeRootObserver?: boolean
)

Parameters

NameTypeRequired
ownerIDisposableOwner | undefinedrequired
targetunknownrequired
initialValueunknownrequired
mustHandleChange((change: IPropertyChange)required
_parent
propertyprotected
protected _parent: ObserverGroup | undefined

Type

ObserverGroup | undefined

addObservers
methodpublic
public addObservers(observers: IObserver[]): ObserverGroup

Parameters

NameTypeRequired
observersIObserver[]required

Returns

ObserverGroup

emitValue
methodpublic
public emitValue(newValue: unknown): void

Parameters

NameTypeRequired
newValueunknownrequired

Returns

void

init
methodpublic
public override init(): void

Parameters

No parameters.

Returns

void

removeObserver
methodpublic
public removeObserver(
  target: unknown,
  id: unknown
): void

Parameters

NameTypeRequired
targetunknownrequired
idunknownrequired

Returns

void

replaceObservers
methodpublic
public replaceObservers(observers: IObserver[]): void

Parameters

NameTypeRequired
observersIObserver[]required

Returns

void

disposeInternal
methodprotected
protected override disposeInternal(): void

Parameters

No parameters.

Returns

void