API Reference

IObjectStateManagerinterface

Interface exported from state-manager.

Overview

Core state tracking module. Contains StateManager (the runtime implementation), IStateManager (its contract), the IStateChange and IContextChanged event payloads, IStateOptions for configuring recursive watches, and IStateEventListener for low-level keyed callbacks.

Quick facts

Kind: interface
Module: state-manager
Extends: IKeyedInstanceFactory< unknown, unknown, IStateForObjectManager >
Members: 2
Package: @rs-x/core
Source: state-manager/object-state-manager.interface.ts

Declaration

export interface IObjectStateManager extends IKeyedInstanceFactory<
  unknown,
  unknown,
  IStateForObjectManager
> {
  replaceState(
    key: unknown,
    newContext: unknown,
    newValue: unknown,
    oldContext: unknown,
    watched: boolean,
    ownerId: unknown,
  ): void;
  isRegistered(context: unknown, key: unknown): boolean;
}

Import

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

Members

2 members in this interface.

isRegistered

method

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

Parameters

Name
Type
Required
context: unknown; required
key: unknown; required

Returns

boolean

replaceState

method

replaceState(
  key: unknown,
  newContext: unknown,
  newValue: unknown,
  oldContext: unknown,
  watched: boolean,
  ownerId: unknown
): void

Parameters

Name
Type
Required
key: unknown; required
newContext: unknown; required
newValue: unknown; required
oldContext: unknown; required
watched: boolean; required
ownerId: unknown; required

Returns

void