API Reference

StateForObjectManagerclass

Per-context state container with reference-counted state entries.

Quick facts
Kind
class
Module
state-manager
Base class
KeyedInstanceFactory<unknown, IValueWithKey, IState, IValueKey>
Implements
IStateForObjectManager
Members
6
Package
@rs-x/core
Source
state-manager/object-state-manager.ts

Import

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

Example

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

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

Members

6 members in this class.

constructor
constructorpublic
constructor(
  private readonly _deepClone: IDeepClone,
  private readonly releaseContext: VoidFunction
)

Parameters

Name
Type
Required
_deepClone
IDeepClone
required
releaseContext
VoidFunction
required
getId
methodpublic
public override getId(data: IValueKey): unknown

Parameters

Name
Type
Required
data
IValueKey
required

Returns

unknown

set
methodpublic
public set(
  key: unknown,
  value: unknown,
  watched: boolean,
  ownerId: unknown
): void

Parameters

Name
Type
Required
key
unknown
required
value
unknown
required
watched
boolean
required
ownerId
unknown
required

Returns

void

createId
methodprotected
protected override createId(data: IValueKey): unknown

Parameters

Name
Type
Required
data
IValueKey
required

Returns

unknown

createInstance
methodprotected
protected override createInstance(data: IValueWithKey): IState

Parameters

Name
Type
Required
data
IValueWithKey
required

Returns

IState

onReleased
methodprotected
protected override onReleased(): void

Parameters

No parameters.

Returns

void